@takeshape/schema 11.52.0 → 11.56.1

package/dist/versions.d.ts

@@ -0,0 +1,4 @@
+export { CURRENT_SCHEMA_VERSION } from './schemas/index.ts';
+export declare const LEGACY_SCHEMA_VERSION = "1.0.0";
+export declare const CURRENT_API_VERSION = "2";
+export declare const LEGACY_API_VERSION = "1";

package/dist/versions.js

@@ -0,0 +1,4 @@
+export { CURRENT_SCHEMA_VERSION } from "./schemas/index.js";
+export const LEGACY_SCHEMA_VERSION = '1.0.0';
+export const CURRENT_API_VERSION = '2';
+export const LEGACY_API_VERSION = '1';

package/dist/workflows.d.ts

@@ -0,0 +1,14 @@
+import type { ProjectSchemaJSON, PropertySchema, ShapeJSON, Workflow, WorkflowMap, WorkflowStep } from './project-schema/index.ts';
+export declare const defaultWorkflow: Workflow;
+export declare function getWorkflow(projectSchema: ProjectSchemaJSON, shapeId: string): Workflow;
+export type StepContext = {
+    index: number;
+    step: WorkflowStep;
+};
+export declare function statusFallback(workflow: Workflow, enabled: boolean): WorkflowStep;
+export declare function findWorkflowStep(workflow: Workflow, keyOrName: string): StepContext | undefined;
+export declare function getStatusField(workflows: WorkflowMap, shape: Pick<ShapeJSON, 'workflow'>): PropertySchema;
+export type WorkflowComparisonOperatorKey = 'lt' | 'lte' | 'gte' | 'gt' | 'eq' | 'in';
+export declare function getStepRange(steps: WorkflowStep[], index: number, op: WorkflowComparisonOperatorKey): WorkflowStep[];
+export declare function getWorkflowStepKeys(workflow: Workflow, stepKey: string, op: WorkflowComparisonOperatorKey): string[];
+export declare function getLiveStepKeys(workflow: Workflow): string[];

package/dist/workflows.js

@@ -0,0 +1,66 @@
+import { getShapeById } from "./util/shapes.js";
+export const defaultWorkflow = {
+    name: 'default',
+    title: 'Default',
+    steps: [
+        {
+            name: 'disabled',
+            title: 'Disabled',
+            key: 'r1uCfi4ZL',
+            color: '#bdbdbd',
+            live: false
+        },
+        {
+            name: 'enabled',
+            title: 'Enabled',
+            key: 'rkhRGs4WL',
+            color: '#5cd79b',
+            live: true
+        }
+    ]
+};
+export function getWorkflow(projectSchema, shapeId) {
+    const workflow = getShapeById(projectSchema, shapeId)?.workflow;
+    if (workflow) {
+        return projectSchema.workflows[workflow] ?? defaultWorkflow;
+    }
+    return defaultWorkflow;
+}
+export function statusFallback(workflow, enabled) {
+    return workflow.steps.find((workflow) => workflow.live === enabled) ?? workflow.steps[0];
+}
+export function findWorkflowStep(workflow, keyOrName) {
+    const index = workflow.steps.findIndex((workflow) => workflow.key === keyOrName || workflow.name === keyOrName);
+    return index === -1 ? undefined : { index, step: workflow.steps[index] };
+}
+export function getStatusField(workflows, shape) {
+    let workflow = defaultWorkflow;
+    if (shape.workflow && workflows[shape.workflow]) {
+        workflow = workflows[shape.workflow];
+    }
+    return {
+        type: 'string',
+        title: 'Status',
+        '@workflow': workflow.name
+    };
+}
+export function getStepRange(steps, index, op) {
+    if (op === 'eq' || op === 'in') {
+        return [steps[index]];
+    }
+    const offset = op === 'lte' || op === 'gte' ? 0 : 1;
+    const start = op === 'gt' || op === 'gte' ? index + offset : 0;
+    const end = op === 'lt' || op === 'lte' ? index + 1 - offset : steps.length;
+    return steps.slice(start, end);
+}
+export function getWorkflowStepKeys(workflow, stepKey, op) {
+    const context = findWorkflowStep(workflow, stepKey);
+    if (!context) {
+        throw new Error(`Cannot find step "${stepKey}" in workflow "${workflow.title}"`);
+    }
+    const { index } = context;
+    return getStepRange(workflow.steps, index, op).map((step) => step.key);
+}
+export function getLiveStepKeys(workflow) {
+    return workflow.steps.filter((step) => step.live).map((step) => step.key);
+}

package/examples/latest/agent-schema.json

@@ -1,7 +1,9 @@
 {
   "projectId": "1c0dc45d-695e-4a87-ac52-13db5e1fd781",
   "defaultLocale": "en-us",
-  "locales": ["en-us"],
+  "locales": [
+    "en-us"
+  ],
   "queries": {
     "dogDelegate": {
       "resolver": {
@@ -120,7 +122,10 @@
             "type": "string"
           }
         },
-        "required": ["answered", "message"]
+        "required": [
+          "answered",
+          "message"
+        ]
       }
     }
   },
@@ -136,7 +141,10 @@
             "widget": "singleLineText"
           }
         },
-        "order": ["name", "color"]
+        "order": [
+          "name",
+          "color"
+        ]
       }
     }
   },
@@ -376,4 +384,4 @@
       }
     }
   }
-}
+}

package/examples/latest/all-fields-shapes-inline.json

@@ -1,7 +1,9 @@
 {
   "projectId": "project-id",
   "defaultLocale": "en-us",
-  "locales": ["en-us"],
+  "locales": [
+    "en-us"
+  ],
   "queries": {
     "getObjectArrayShape": {
       "shape": "ObjectArrayShape",
@@ -188,11 +190,15 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": [1]
+                  "enum": [
+                    1
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": [2]
+                  "enum": [
+                    2
+                  ]
                 }
               ]
             },
@@ -216,11 +222,15 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": [true]
+                  "enum": [
+                    true
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": [false]
+                  "enum": [
+                    false
+                  ]
                 }
               ]
             },
@@ -244,11 +254,15 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": ["option1"]
+                  "enum": [
+                    "option1"
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": ["option2"]
+                  "enum": [
+                    "option2"
+                  ]
                 }
               ]
             },
@@ -364,7 +378,9 @@
             "widget": "singleLineText"
           }
         },
-        "order": ["string"]
+        "order": [
+          "string"
+        ]
       }
     },
     "NumberShape": {
@@ -374,7 +390,9 @@
             "widget": "number"
           }
         },
-        "order": ["number"]
+        "order": [
+          "number"
+        ]
       }
     },
     "BooleanShape": {
@@ -384,7 +402,9 @@
             "widget": "checkbox"
           }
         },
-        "order": ["boolean"]
+        "order": [
+          "boolean"
+        ]
       }
     },
     "NumberArrayShape": {
@@ -394,7 +414,9 @@
             "widget": "numberCheckboxes"
           }
         },
-        "order": ["numberArray"]
+        "order": [
+          "numberArray"
+        ]
       }
     },
     "BooleanArrayShape": {
@@ -404,7 +426,9 @@
             "widget": "booleanCheckboxes"
           }
         },
-        "order": ["booleanArray"]
+        "order": [
+          "booleanArray"
+        ]
       }
     },
     "StringArrayShape": {
@@ -414,7 +438,9 @@
             "widget": "checkboxes"
           }
         },
-        "order": ["stringArray"]
+        "order": [
+          "stringArray"
+        ]
       }
     },
     "AssetShape": {
@@ -424,7 +450,9 @@
             "widget": "image"
           }
         },
-        "order": ["asset"]
+        "order": [
+          "asset"
+        ]
       }
     },
     "AssetArrayShape": {
@@ -436,7 +464,9 @@
             }
           }
         },
-        "order": ["assetArray"]
+        "order": [
+          "assetArray"
+        ]
       }
     },
     "ObjectShape": {
@@ -446,7 +476,9 @@
             "widget": "shapeObject"
           }
         },
-        "order": ["object"]
+        "order": [
+          "object"
+        ]
       }
     },
     "ObjectArrayShape": {
@@ -456,10 +488,12 @@
             "widget": "shapeArray"
           }
         },
-        "order": ["objectArray"]
+        "order": [
+          "objectArray"
+        ]
       }
     }
   },
   "schemaVersion": "3.51.0",
   "apiVersion": "2"
-}
+}

package/examples/latest/all-fields-shapes.json

@@ -1,7 +1,9 @@
 {
   "projectId": "project-id",
   "defaultLocale": "en-us",
-  "locales": ["en-us"],
+  "locales": [
+    "en-us"
+  ],
   "queries": {
     "getStringShape": {
       "shape": "StringShape",
@@ -503,7 +505,9 @@
             "title": "String"
           }
         },
-        "required": ["string"]
+        "required": [
+          "string"
+        ]
       }
     },
     "ObjectShape": {
@@ -548,7 +552,9 @@
             "title": "Number"
           }
         },
-        "required": ["number"]
+        "required": [
+          "number"
+        ]
       }
     },
     "BooleanShape": {
@@ -568,7 +574,9 @@
             "title": "Boolean"
           }
         },
-        "required": ["boolean"]
+        "required": [
+          "boolean"
+        ]
       }
     },
     "NumberArrayShape": {
@@ -589,18 +597,24 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": [1]
+                  "enum": [
+                    1
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": [2]
+                  "enum": [
+                    2
+                  ]
                 }
               ]
             },
             "title": "Number Array"
           }
         },
-        "required": ["numberArray"]
+        "required": [
+          "numberArray"
+        ]
       }
     },
     "BooleanArrayShape": {
@@ -621,18 +635,24 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": [true]
+                  "enum": [
+                    true
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": [false]
+                  "enum": [
+                    false
+                  ]
                 }
               ]
             },
             "title": "Boolean Array"
           }
         },
-        "required": ["booleanArray"]
+        "required": [
+          "booleanArray"
+        ]
       }
     },
     "StringArrayShape": {
@@ -653,18 +673,24 @@
               "oneOf": [
                 {
                   "title": "Option 1",
-                  "enum": ["option1"]
+                  "enum": [
+                    "option1"
+                  ]
                 },
                 {
                   "title": "Option 2",
-                  "enum": ["option2"]
+                  "enum": [
+                    "option2"
+                  ]
                 }
               ]
             },
             "title": "String Array"
           }
         },
-        "required": ["stringArray"]
+        "required": [
+          "stringArray"
+        ]
       }
     },
     "AssetShape": {
@@ -694,7 +720,9 @@
             }
           }
         },
-        "required": ["asset"]
+        "required": [
+          "asset"
+        ]
       }
     },
     "AssetArrayShape": {
@@ -730,7 +758,9 @@
             "@mapping": "shapedb:AssetArrayShape.WkzdxMYIe"
           }
         },
-        "required": ["assetArray"]
+        "required": [
+          "assetArray"
+        ]
       }
     },
     "ObjectArrayShape": {
@@ -769,7 +799,9 @@
             "widget": "singleLineText"
           }
         },
-        "order": ["string"]
+        "order": [
+          "string"
+        ]
       }
     },
     "ObjectShape": {
@@ -779,7 +811,9 @@
             "widget": "relationship"
           }
         },
-        "order": ["object"]
+        "order": [
+          "object"
+        ]
       }
     },
     "NumberShape": {
@@ -789,7 +823,9 @@
             "widget": "number"
           }
         },
-        "order": ["number"]
+        "order": [
+          "number"
+        ]
       }
     },
     "BooleanShape": {
@@ -799,7 +835,9 @@
             "widget": "checkbox"
           }
         },
-        "order": ["boolean"]
+        "order": [
+          "boolean"
+        ]
       }
     },
     "NumberArrayShape": {
@@ -809,7 +847,9 @@
             "widget": "numberCheckboxes"
           }
         },
-        "order": ["numberArray"]
+        "order": [
+          "numberArray"
+        ]
       }
     },
     "BooleanArrayShape": {
@@ -819,7 +859,9 @@
             "widget": "booleanCheckboxes"
           }
         },
-        "order": ["booleanArray"]
+        "order": [
+          "booleanArray"
+        ]
       }
     },
     "StringArrayShape": {
@@ -829,7 +871,9 @@
             "widget": "checkboxes"
           }
         },
-        "order": ["stringArray"]
+        "order": [
+          "stringArray"
+        ]
       }
     },
     "AssetShape": {
@@ -839,7 +883,9 @@
             "widget": "image"
           }
         },
-        "order": ["asset"]
+        "order": [
+          "asset"
+        ]
       }
     },
     "AssetArrayShape": {
@@ -851,7 +897,9 @@
             }
           }
         },
-        "order": ["assetArray"]
+        "order": [
+          "assetArray"
+        ]
       }
     },
     "ObjectArrayShape": {
@@ -861,10 +909,12 @@
             "widget": "relationship"
           }
         },
-        "order": ["objectArray"]
+        "order": [
+          "objectArray"
+        ]
       }
     }
   },
   "schemaVersion": "3.51.0",
   "apiVersion": "2"
-}
+}