Skip to content

Commit

Permalink
fix: add changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rohan Bansal committed Dec 16, 2024
1 parent 2cee49f commit cef03d4
Show file tree
Hide file tree
Showing 20 changed files with 265 additions and 15 deletions.
1 change: 1 addition & 0 deletions aform/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export type { CellContext, TableConfig, TableColumn, TableRow } from '@stonecrop/atable'
import { App } from 'vue'

import ACheckbox from './components/form/ACheckbox.vue'
Expand Down
2 changes: 1 addition & 1 deletion aform/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ export type FieldsetSchema = BasicSchema & {

/**
* Superset of schema types
* @public
* @beta
*/
export type SchemaTypes = FormSchema | TableSchema | FieldsetSchema
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/aform",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/aform"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/atable",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/atable"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/beam",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/beam"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/code-editor",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/code-editor"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/desktop",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/desktop"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/graphql-client",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/graphql-client"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/node-editor",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/node-editor"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/stonecrop",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/stonecrop"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@stonecrop/utilities",
"comment": "update import paths to avoid API extraction bugs",
"type": "patch"
}
],
"packageName": "@stonecrop/utilities"
}
2 changes: 1 addition & 1 deletion common/config/rush/version-policies.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"definitionName": "lockStepVersion",
"policyName": "stonecrop",
"version": "0.2.67",
"nextBump": "patch"
"nextBump": "minor"
}
// {
// /**
Expand Down
51 changes: 40 additions & 11 deletions common/reviews/api/aform.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ export type BasicSchema = {
value: any;
};

// @public
export type CellContext = {
row: TableRow;
column: TableColumn;
table: {
[key: string]: any;
};
};

// @beta
export type FieldsetSchema = BasicSchema & {
label: string;
Expand All @@ -67,26 +76,46 @@ export function install(app: App): void;

export { Login }

// Warning: (ae-incompatible-release-tags) The symbol "SchemaTypes" is marked as @public, but its signature references "FormSchema" which is marked as @beta
// Warning: (ae-incompatible-release-tags) The symbol "SchemaTypes" is marked as @public, but its signature references "TableSchema" which is marked as @beta
// Warning: (ae-incompatible-release-tags) The symbol "SchemaTypes" is marked as @public, but its signature references "FieldsetSchema" which is marked as @beta
//
// @public
// @beta
export type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;

// @public
export type TableColumn = {
name: string;
align?: CanvasTextAlign;
edit?: boolean;
label?: string;
type?: string;
width?: string;
pinned?: boolean;
cellComponent?: string;
cellComponentProps?: Record<string, any>;
modalComponent?: string | ((context?: CellContext) => string);
modalComponentExtraProps?: Record<string, any>;
format?: string | ((value: any, context?: CellContext) => string);
mask?: (value: any) => any;
};

// @public
export type TableConfig = {
view?: 'uncounted' | 'list' | 'list-expansion' | 'tree';
fullWidth?: boolean;
};

// @public
export type TableRow = {
[key: string]: any;
indent?: number;
parent?: number;
};

// @beta
export type TableSchema = BasicSchema & {
columns: TableColumn[];
config: TableConfig;
rows: TableRow[];
};

// Warnings were encountered during analysis:
//
// src/types/index.ts:45:2 - (ae-forgotten-export) The symbol "TableColumn" needs to be exported by the entry point index.d.ts
// src/types/index.ts:46:2 - (ae-forgotten-export) The symbol "TableConfig" needs to be exported by the entry point index.d.ts
// src/types/index.ts:47:2 - (ae-forgotten-export) The symbol "TableRow" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

```
21 changes: 21 additions & 0 deletions docs/aform/aform.cellcontext.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@stonecrop/aform](./aform.md) &gt; [CellContext](./aform.cellcontext.md)

## CellContext type

Table cell context definition.

**Signature:**

```typescript
export type CellContext = {
row: TableRow;
column: TableColumn;
table: {
[key: string]: any;
};
};
```
**References:** [TableRow](./aform.tablerow.md)<!-- -->, [TableColumn](./aform.tablecolumn.md)

46 changes: 45 additions & 1 deletion docs/aform/aform.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,17 @@ Description
**_(BETA)_** Base schemda for AForm components


</td></tr>
<tr><td>

[CellContext](./aform.cellcontext.md)


</td><td>

Table cell context definition.


</td></tr>
<tr><td>

Expand Down Expand Up @@ -83,7 +94,40 @@ Description

</td><td>

Superset of schema types
**_(BETA)_** Superset of schema types


</td></tr>
<tr><td>

[TableColumn](./aform.tablecolumn.md)


</td><td>

Table column definition.


</td></tr>
<tr><td>

[TableConfig](./aform.tableconfig.md)


</td><td>

Table configuration definition.


</td></tr>
<tr><td>

[TableRow](./aform.tablerow.md)


</td><td>

Table row definition.


</td></tr>
Expand Down
3 changes: 3 additions & 0 deletions docs/aform/aform.schematypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

## SchemaTypes type

> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
Superset of schema types

**Signature:**
Expand Down
29 changes: 29 additions & 0 deletions docs/aform/aform.tablecolumn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@stonecrop/aform](./aform.md) &gt; [TableColumn](./aform.tablecolumn.md)

## TableColumn type

Table column definition.

**Signature:**

```typescript
export type TableColumn = {
name: string;
align?: CanvasTextAlign;
edit?: boolean;
label?: string;
type?: string;
width?: string;
pinned?: boolean;
cellComponent?: string;
cellComponentProps?: Record<string, any>;
modalComponent?: string | ((context?: CellContext) => string);
modalComponentExtraProps?: Record<string, any>;
format?: string | ((value: any, context?: CellContext) => string);
mask?: (value: any) => any;
};
```
**References:** [CellContext](./aform.cellcontext.md)

16 changes: 16 additions & 0 deletions docs/aform/aform.tableconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@stonecrop/aform](./aform.md) &gt; [TableConfig](./aform.tableconfig.md)

## TableConfig type

Table configuration definition.

**Signature:**

```typescript
export type TableConfig = {
view?: 'uncounted' | 'list' | 'list-expansion' | 'tree';
fullWidth?: boolean;
};
```
17 changes: 17 additions & 0 deletions docs/aform/aform.tablerow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@stonecrop/aform](./aform.md) &gt; [TableRow](./aform.tablerow.md)

## TableRow type

Table row definition.

**Signature:**

```typescript
export type TableRow = {
[key: string]: any;
indent?: number;
parent?: number;
};
```
2 changes: 1 addition & 1 deletion docs/aform/aform.tableschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ export type TableSchema = BasicSchema & {
rows: TableRow[];
};
```
**References:** [BasicSchema](./aform.basicschema.md)
**References:** [BasicSchema](./aform.basicschema.md)<!-- -->, [TableColumn](./aform.tablecolumn.md)<!-- -->, [TableConfig](./aform.tableconfig.md)<!-- -->, [TableRow](./aform.tablerow.md)

0 comments on commit cef03d4

Please sign in to comment.