@signstack/cli 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +458 -0
- package/bin/run.js +12 -0
- package/dist/apps/signstack-cli/schemas/asset.schema.json +220 -0
- package/dist/apps/signstack-cli/schemas/blueprint.schema.json +485 -0
- package/dist/apps/signstack-cli/schemas/jsonata-function.schema.json +185 -0
- package/dist/apps/signstack-cli/schemas/schema.schema.json +97 -0
- package/dist/apps/signstack-cli/schemas/template.schema.json +295 -0
- package/dist/apps/signstack-cli/src/commands/auth/login.d.ts +25 -0
- package/dist/apps/signstack-cli/src/commands/auth/login.js +229 -0
- package/dist/apps/signstack-cli/src/commands/auth/login.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/auth/logout.d.ts +10 -0
- package/dist/apps/signstack-cli/src/commands/auth/logout.js +59 -0
- package/dist/apps/signstack-cli/src/commands/auth/logout.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/auth/whoami.d.ts +9 -0
- package/dist/apps/signstack-cli/src/commands/auth/whoami.js +85 -0
- package/dist/apps/signstack-cli/src/commands/auth/whoami.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/generate.d.ts +51 -0
- package/dist/apps/signstack-cli/src/commands/generate.js +479 -0
- package/dist/apps/signstack-cli/src/commands/generate.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/preview.d.ts +24 -0
- package/dist/apps/signstack-cli/src/commands/preview.js +162 -0
- package/dist/apps/signstack-cli/src/commands/preview.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/pull.d.ts +28 -0
- package/dist/apps/signstack-cli/src/commands/pull.js +244 -0
- package/dist/apps/signstack-cli/src/commands/pull.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/push.d.ts +46 -0
- package/dist/apps/signstack-cli/src/commands/push.js +460 -0
- package/dist/apps/signstack-cli/src/commands/push.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/run.d.ts +22 -0
- package/dist/apps/signstack-cli/src/commands/run.js +126 -0
- package/dist/apps/signstack-cli/src/commands/run.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/test.d.ts +6 -0
- package/dist/apps/signstack-cli/src/commands/test.js +25 -0
- package/dist/apps/signstack-cli/src/commands/test.js.map +1 -0
- package/dist/apps/signstack-cli/src/commands/validate.d.ts +59 -0
- package/dist/apps/signstack-cli/src/commands/validate.js +558 -0
- package/dist/apps/signstack-cli/src/commands/validate.js.map +1 -0
- package/dist/apps/signstack-cli/src/index.d.ts +1 -0
- package/dist/apps/signstack-cli/src/index.js +2 -0
- package/dist/apps/signstack-cli/src/index.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/api-client.d.ts +77 -0
- package/dist/apps/signstack-cli/src/lib/api-client.js +269 -0
- package/dist/apps/signstack-cli/src/lib/api-client.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/base-command.d.ts +38 -0
- package/dist/apps/signstack-cli/src/lib/base-command.js +135 -0
- package/dist/apps/signstack-cli/src/lib/base-command.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/config.d.ts +47 -0
- package/dist/apps/signstack-cli/src/lib/config.js +106 -0
- package/dist/apps/signstack-cli/src/lib/config.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/entity-data-resolver.d.ts +31 -0
- package/dist/apps/signstack-cli/src/lib/entity-data-resolver.js +107 -0
- package/dist/apps/signstack-cli/src/lib/entity-data-resolver.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/local-resource-loader.d.ts +72 -0
- package/dist/apps/signstack-cli/src/lib/local-resource-loader.js +238 -0
- package/dist/apps/signstack-cli/src/lib/local-resource-loader.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/path-utils.d.ts +4 -0
- package/dist/apps/signstack-cli/src/lib/path-utils.js +7 -0
- package/dist/apps/signstack-cli/src/lib/path-utils.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/payload-builder.d.ts +127 -0
- package/dist/apps/signstack-cli/src/lib/payload-builder.js +545 -0
- package/dist/apps/signstack-cli/src/lib/payload-builder.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/preview-handler.d.ts +95 -0
- package/dist/apps/signstack-cli/src/lib/preview-handler.js +611 -0
- package/dist/apps/signstack-cli/src/lib/preview-handler.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/preview-output-formatter.d.ts +63 -0
- package/dist/apps/signstack-cli/src/lib/preview-output-formatter.js +198 -0
- package/dist/apps/signstack-cli/src/lib/preview-output-formatter.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/public-api-client.d.ts +13 -0
- package/dist/apps/signstack-cli/src/lib/public-api-client.js +39 -0
- package/dist/apps/signstack-cli/src/lib/public-api-client.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/resource-puller.d.ts +131 -0
- package/dist/apps/signstack-cli/src/lib/resource-puller.js +800 -0
- package/dist/apps/signstack-cli/src/lib/resource-puller.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/resource-pusher.d.ts +87 -0
- package/dist/apps/signstack-cli/src/lib/resource-pusher.js +361 -0
- package/dist/apps/signstack-cli/src/lib/resource-pusher.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/resource-scanner.d.ts +29 -0
- package/dist/apps/signstack-cli/src/lib/resource-scanner.js +101 -0
- package/dist/apps/signstack-cli/src/lib/resource-scanner.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/resource-validator.d.ts +44 -0
- package/dist/apps/signstack-cli/src/lib/resource-validator.js +158 -0
- package/dist/apps/signstack-cli/src/lib/resource-validator.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/run-handler.d.ts +47 -0
- package/dist/apps/signstack-cli/src/lib/run-handler.js +266 -0
- package/dist/apps/signstack-cli/src/lib/run-handler.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/safe-path.d.ts +28 -0
- package/dist/apps/signstack-cli/src/lib/safe-path.js +44 -0
- package/dist/apps/signstack-cli/src/lib/safe-path.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/scenario-file.d.ts +35 -0
- package/dist/apps/signstack-cli/src/lib/scenario-file.js +80 -0
- package/dist/apps/signstack-cli/src/lib/scenario-file.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/schema-validator.d.ts +8 -0
- package/dist/apps/signstack-cli/src/lib/schema-validator.js +39 -0
- package/dist/apps/signstack-cli/src/lib/schema-validator.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/url-validator.d.ts +17 -0
- package/dist/apps/signstack-cli/src/lib/url-validator.js +61 -0
- package/dist/apps/signstack-cli/src/lib/url-validator.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/yaml-document-parser.d.ts +25 -0
- package/dist/apps/signstack-cli/src/lib/yaml-document-parser.js +133 -0
- package/dist/apps/signstack-cli/src/lib/yaml-document-parser.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/yaml-transforms.d.ts +3 -0
- package/dist/apps/signstack-cli/src/lib/yaml-transforms.js +32 -0
- package/dist/apps/signstack-cli/src/lib/yaml-transforms.js.map +1 -0
- package/dist/apps/signstack-cli/src/lib/yaml-writer.d.ts +47 -0
- package/dist/apps/signstack-cli/src/lib/yaml-writer.js +160 -0
- package/dist/apps/signstack-cli/src/lib/yaml-writer.js.map +1 -0
- package/dist/apps/signstack-cli/src/types/auth.types.d.ts +48 -0
- package/dist/apps/signstack-cli/src/types/auth.types.js +31 -0
- package/dist/apps/signstack-cli/src/types/auth.types.js.map +1 -0
- package/dist/apps/signstack-cli/src/types/schema.types.d.ts +14 -0
- package/dist/apps/signstack-cli/src/types/schema.types.js +16 -0
- package/dist/apps/signstack-cli/src/types/schema.types.js.map +1 -0
- package/dist/apps/signstack-cli/src/types/yaml.types.d.ts +144 -0
- package/dist/apps/signstack-cli/src/types/yaml.types.js +2 -0
- package/dist/apps/signstack-cli/src/types/yaml.types.js.map +1 -0
- package/dist/libs/common/base/src/index.d.ts +14 -0
- package/dist/libs/common/base/src/index.js +44 -0
- package/dist/libs/common/base/src/index.js.map +1 -0
- package/dist/libs/common/base/src/lib/address.util.d.ts +12 -0
- package/dist/libs/common/base/src/lib/address.util.js +55 -0
- package/dist/libs/common/base/src/lib/address.util.js.map +1 -0
- package/dist/libs/common/base/src/lib/country-code-data.d.ts +5 -0
- package/dist/libs/common/base/src/lib/country-code-data.js +1256 -0
- package/dist/libs/common/base/src/lib/country-code-data.js.map +1 -0
- package/dist/libs/common/base/src/lib/date.util.d.ts +13 -0
- package/dist/libs/common/base/src/lib/date.util.js +135 -0
- package/dist/libs/common/base/src/lib/date.util.js.map +1 -0
- package/dist/libs/common/base/src/lib/headers.d.ts +1 -0
- package/dist/libs/common/base/src/lib/headers.js +5 -0
- package/dist/libs/common/base/src/lib/headers.js.map +1 -0
- package/dist/libs/common/base/src/lib/jsonata.service.d.ts +32 -0
- package/dist/libs/common/base/src/lib/jsonata.service.js +207 -0
- package/dist/libs/common/base/src/lib/jsonata.service.js.map +1 -0
- package/dist/libs/common/base/src/lib/key-validation.constants.d.ts +37 -0
- package/dist/libs/common/base/src/lib/key-validation.constants.js +144 -0
- package/dist/libs/common/base/src/lib/key-validation.constants.js.map +1 -0
- package/dist/libs/common/base/src/lib/phone-util.d.ts +16 -0
- package/dist/libs/common/base/src/lib/phone-util.js +61 -0
- package/dist/libs/common/base/src/lib/phone-util.js.map +1 -0
- package/dist/libs/common/base/src/lib/schema-validation.util.d.ts +24 -0
- package/dist/libs/common/base/src/lib/schema-validation.util.js +155 -0
- package/dist/libs/common/base/src/lib/schema-validation.util.js.map +1 -0
- package/dist/libs/common/base/src/lib/string-builder.d.ts +48 -0
- package/dist/libs/common/base/src/lib/string-builder.js +90 -0
- package/dist/libs/common/base/src/lib/string-builder.js.map +1 -0
- package/dist/libs/common/base/src/lib/util.d.ts +20 -0
- package/dist/libs/common/base/src/lib/util.js +110 -0
- package/dist/libs/common/base/src/lib/util.js.map +1 -0
- package/dist/libs/signstack/base/schemas/asset.schema.json +220 -0
- package/dist/libs/signstack/base/schemas/blueprint.schema.json +485 -0
- package/dist/libs/signstack/base/schemas/jsonata-function.schema.json +185 -0
- package/dist/libs/signstack/base/schemas/schema.schema.json +97 -0
- package/dist/libs/signstack/base/schemas/template.schema.json +295 -0
- package/dist/libs/signstack/base/src/index.d.ts +28 -0
- package/dist/libs/signstack/base/src/index.js +32 -0
- package/dist/libs/signstack/base/src/index.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/constants.d.ts +123 -0
- package/dist/libs/signstack/base/src/lib/constants.js +131 -0
- package/dist/libs/signstack/base/src/lib/constants.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/hash.util.d.ts +58 -0
- package/dist/libs/signstack/base/src/lib/hash.util.js +90 -0
- package/dist/libs/signstack/base/src/lib/hash.util.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/is-schema-renderable.util.d.ts +29 -0
- package/dist/libs/signstack/base/src/lib/is-schema-renderable.util.js +93 -0
- package/dist/libs/signstack/base/src/lib/is-schema-renderable.util.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/ai-chat.d.ts +41 -0
- package/dist/libs/signstack/base/src/lib/models/ai-chat.js +3 -0
- package/dist/libs/signstack/base/src/lib/models/ai-chat.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/api-key.d.ts +54 -0
- package/dist/libs/signstack/base/src/lib/models/api-key.js +18 -0
- package/dist/libs/signstack/base/src/lib/models/api-key.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/asset.d.ts +101 -0
- package/dist/libs/signstack/base/src/lib/models/asset.js +11 -0
- package/dist/libs/signstack/base/src/lib/models/asset.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/auth.d.ts +142 -0
- package/dist/libs/signstack/base/src/lib/models/auth.js +35 -0
- package/dist/libs/signstack/base/src/lib/models/auth.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/base.d.ts +134 -0
- package/dist/libs/signstack/base/src/lib/models/base.js +71 -0
- package/dist/libs/signstack/base/src/lib/models/base.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/blueprint.d.ts +311 -0
- package/dist/libs/signstack/base/src/lib/models/blueprint.js +9 -0
- package/dist/libs/signstack/base/src/lib/models/blueprint.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/file.d.ts +75 -0
- package/dist/libs/signstack/base/src/lib/models/file.js +9 -0
- package/dist/libs/signstack/base/src/lib/models/file.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/jsonata-function.d.ts +111 -0
- package/dist/libs/signstack/base/src/lib/models/jsonata-function.js +19 -0
- package/dist/libs/signstack/base/src/lib/models/jsonata-function.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/marketplace-listing.d.ts +132 -0
- package/dist/libs/signstack/base/src/lib/models/marketplace-listing.js +22 -0
- package/dist/libs/signstack/base/src/lib/models/marketplace-listing.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/membership.d.ts +127 -0
- package/dist/libs/signstack/base/src/lib/models/membership.js +22 -0
- package/dist/libs/signstack/base/src/lib/models/membership.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/namespace.d.ts +87 -0
- package/dist/libs/signstack/base/src/lib/models/namespace.js +57 -0
- package/dist/libs/signstack/base/src/lib/models/namespace.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/organization.d.ts +79 -0
- package/dist/libs/signstack/base/src/lib/models/organization.js +41 -0
- package/dist/libs/signstack/base/src/lib/models/organization.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/render-job.d.ts +88 -0
- package/dist/libs/signstack/base/src/lib/models/render-job.js +3 -0
- package/dist/libs/signstack/base/src/lib/models/render-job.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/resource-edge.d.ts +60 -0
- package/dist/libs/signstack/base/src/lib/models/resource-edge.js +202 -0
- package/dist/libs/signstack/base/src/lib/models/resource-edge.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/scenario.d.ts +138 -0
- package/dist/libs/signstack/base/src/lib/models/scenario.js +14 -0
- package/dist/libs/signstack/base/src/lib/models/scenario.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/schema.d.ts +131 -0
- package/dist/libs/signstack/base/src/lib/models/schema.js +44 -0
- package/dist/libs/signstack/base/src/lib/models/schema.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/shareable-link.d.ts +215 -0
- package/dist/libs/signstack/base/src/lib/models/shareable-link.js +27 -0
- package/dist/libs/signstack/base/src/lib/models/shareable-link.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/subscription.d.ts +279 -0
- package/dist/libs/signstack/base/src/lib/models/subscription.js +105 -0
- package/dist/libs/signstack/base/src/lib/models/subscription.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/template.d.ts +248 -0
- package/dist/libs/signstack/base/src/lib/models/template.js +32 -0
- package/dist/libs/signstack/base/src/lib/models/template.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/user.d.ts +30 -0
- package/dist/libs/signstack/base/src/lib/models/user.js +3 -0
- package/dist/libs/signstack/base/src/lib/models/user.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/webhook.d.ts +223 -0
- package/dist/libs/signstack/base/src/lib/models/webhook.js +62 -0
- package/dist/libs/signstack/base/src/lib/models/webhook.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/models/workflow.d.ts +917 -0
- package/dist/libs/signstack/base/src/lib/models/workflow.js +152 -0
- package/dist/libs/signstack/base/src/lib/models/workflow.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/util.d.ts +92 -0
- package/dist/libs/signstack/base/src/lib/util.js +406 -0
- package/dist/libs/signstack/base/src/lib/util.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/dependency-graph.d.ts +94 -0
- package/dist/libs/signstack/base/src/lib/validation/dependency-graph.js +446 -0
- package/dist/libs/signstack/base/src/lib/validation/dependency-graph.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/graph.types.d.ts +57 -0
- package/dist/libs/signstack/base/src/lib/validation/graph.types.js +8 -0
- package/dist/libs/signstack/base/src/lib/validation/graph.types.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/index.d.ts +9 -0
- package/dist/libs/signstack/base/src/lib/validation/index.js +23 -0
- package/dist/libs/signstack/base/src/lib/validation/index.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/resource-schemas.d.ts +3 -0
- package/dist/libs/signstack/base/src/lib/validation/resource-schemas.js +27 -0
- package/dist/libs/signstack/base/src/lib/validation/resource-schemas.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validation.types.d.ts +57 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validation.types.js +57 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validation.types.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validator.d.ts +38 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validator.js +146 -0
- package/dist/libs/signstack/base/src/lib/validation/schema-validator.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-dependencies.d.ts +22 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-dependencies.js +69 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-dependencies.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-resource-tree.d.ts +37 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-resource-tree.js +250 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-resource-tree.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-template-inputs.d.ts +24 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-template-inputs.js +98 -0
- package/dist/libs/signstack/base/src/lib/validation/validate-template-inputs.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/validation/yaml-document-utils.d.ts +12 -0
- package/dist/libs/signstack/base/src/lib/validation/yaml-document-utils.js +50 -0
- package/dist/libs/signstack/base/src/lib/validation/yaml-document-utils.js.map +1 -0
- package/dist/libs/signstack/base/src/lib/yaml-spec-converter.d.ts +101 -0
- package/dist/libs/signstack/base/src/lib/yaml-spec-converter.js +998 -0
- package/dist/libs/signstack/base/src/lib/yaml-spec-converter.js.map +1 -0
- package/oclif.manifest.json +822 -0
- package/package.json +101 -0
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
import { WorkflowStepType, WorkflowStepExecutionMode, WorkflowStepCompletionRule, ParticipantActionType, DocumentAssignment, EnvelopeResolutionMode, CustomFieldConfig, CreateWorkflowMode } from './workflow';
|
|
2
|
+
import { ActorRef, ListResp, LiteralOrExpression, ResourceListItemBase, ResourceMetadata, VersionType } from './base';
|
|
3
|
+
import { FunctionDependency } from './jsonata-function';
|
|
4
|
+
import type { Input, OverlayField, TemplateFieldInfo, TemplateResource } from './template';
|
|
5
|
+
import type { AssetResource } from './asset';
|
|
6
|
+
import type { JsonataFunctionResource } from './jsonata-function';
|
|
7
|
+
import type { SchemaResource } from './schema';
|
|
8
|
+
export type BlueprintStepType = WorkflowStepType;
|
|
9
|
+
export declare const BlueprintStepType: typeof WorkflowStepType;
|
|
10
|
+
export type BlueprintStepExecutionMode = WorkflowStepExecutionMode;
|
|
11
|
+
export declare const BlueprintStepExecutionMode: typeof WorkflowStepExecutionMode;
|
|
12
|
+
export type BlueprintStepCompletionRule = WorkflowStepCompletionRule;
|
|
13
|
+
export declare const BlueprintStepCompletionRule: typeof WorkflowStepCompletionRule;
|
|
14
|
+
export { ParticipantActionType as ParticipantTaskType };
|
|
15
|
+
export interface BlueprintResource {
|
|
16
|
+
metadata: ResourceMetadata;
|
|
17
|
+
spec: BlueprintSpec;
|
|
18
|
+
}
|
|
19
|
+
export interface BlueprintSpec {
|
|
20
|
+
inputs?: Input[];
|
|
21
|
+
participants?: BlueprintParticipant[];
|
|
22
|
+
envelopes: BlueprintEnvelope[];
|
|
23
|
+
orchestration?: BlueprintStep;
|
|
24
|
+
customFields?: CustomFieldConfig[];
|
|
25
|
+
functions?: FunctionDependency[];
|
|
26
|
+
}
|
|
27
|
+
export interface BlueprintEnvelope {
|
|
28
|
+
key: string;
|
|
29
|
+
subject: string;
|
|
30
|
+
documents: {
|
|
31
|
+
key: string;
|
|
32
|
+
name: string;
|
|
33
|
+
templateKey?: string;
|
|
34
|
+
templateVersion?: string;
|
|
35
|
+
inputMap?: BlueprintInputMapLink[];
|
|
36
|
+
includeIf?: string;
|
|
37
|
+
fileId?: LiteralOrExpression<string>;
|
|
38
|
+
iterator?: string;
|
|
39
|
+
}[];
|
|
40
|
+
resolutionMode?: EnvelopeResolutionMode;
|
|
41
|
+
}
|
|
42
|
+
export interface BlueprintInputMapLink {
|
|
43
|
+
templateInputKey: string;
|
|
44
|
+
blueprintInputKey: string;
|
|
45
|
+
}
|
|
46
|
+
export interface BlueprintDocument {
|
|
47
|
+
key: string;
|
|
48
|
+
name: string;
|
|
49
|
+
templateKey: string;
|
|
50
|
+
templateVersion: string;
|
|
51
|
+
filePath?: string;
|
|
52
|
+
fileName?: string;
|
|
53
|
+
inputMap?: BlueprintInputMapLink[];
|
|
54
|
+
}
|
|
55
|
+
export interface BlueprintParticipant {
|
|
56
|
+
key: string;
|
|
57
|
+
name: string;
|
|
58
|
+
roleCategory?: string;
|
|
59
|
+
participantName: LiteralOrExpression<string>;
|
|
60
|
+
participantEmail: LiteralOrExpression<string>;
|
|
61
|
+
}
|
|
62
|
+
export interface ParticipantAction {
|
|
63
|
+
type: ParticipantActionType;
|
|
64
|
+
envelopeKey: string;
|
|
65
|
+
assignments: DocumentAssignment[];
|
|
66
|
+
}
|
|
67
|
+
export interface BlueprintStepOnComplete {
|
|
68
|
+
validate?: string;
|
|
69
|
+
updates?: {
|
|
70
|
+
key: string;
|
|
71
|
+
transform: string;
|
|
72
|
+
}[];
|
|
73
|
+
}
|
|
74
|
+
export interface BlueprintStepBase {
|
|
75
|
+
key: string;
|
|
76
|
+
name?: string;
|
|
77
|
+
includeIf?: string;
|
|
78
|
+
type: BlueprintStepType;
|
|
79
|
+
onComplete?: BlueprintStepOnComplete;
|
|
80
|
+
}
|
|
81
|
+
export interface BlueprintGroupStep extends BlueprintStepBase {
|
|
82
|
+
type: WorkflowStepType.Group;
|
|
83
|
+
execution: BlueprintStepExecutionMode;
|
|
84
|
+
completion?: BlueprintStepCompletionRule;
|
|
85
|
+
quorum?: number;
|
|
86
|
+
children: BlueprintStep[];
|
|
87
|
+
}
|
|
88
|
+
export interface BlueprintParticipantStep extends BlueprintStepBase {
|
|
89
|
+
type: WorkflowStepType.Participant;
|
|
90
|
+
participantKey: string;
|
|
91
|
+
action?: ParticipantAction;
|
|
92
|
+
}
|
|
93
|
+
export type BlueprintStep = BlueprintGroupStep | BlueprintParticipantStep;
|
|
94
|
+
export interface ListBlueprintsReq {
|
|
95
|
+
skipDraft?: boolean;
|
|
96
|
+
limit?: number;
|
|
97
|
+
offset?: number;
|
|
98
|
+
search?: string;
|
|
99
|
+
labels?: Record<string, string>;
|
|
100
|
+
}
|
|
101
|
+
export type ListBlueprintsResp = ListResp<BlueprintListItem>;
|
|
102
|
+
export type ListBlueprintVersionsResp = ListResp<BlueprintListItem>;
|
|
103
|
+
export interface BlueprintListItem extends ResourceListItemBase {
|
|
104
|
+
spec: {
|
|
105
|
+
inputs?: Input[];
|
|
106
|
+
participants?: {
|
|
107
|
+
key: string;
|
|
108
|
+
name: string;
|
|
109
|
+
}[];
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Full blueprint — returned by `GET /blueprints/{key}`, `POST /blueprints`,
|
|
114
|
+
* `PUT .../versions/draft`, and `POST .../versions/draft/publish`. The
|
|
115
|
+
* optimistic-locking handle is returned in the HTTP `ETag` response header
|
|
116
|
+
* (RFC 7232) — pass it back as `If-Match` on the next `PUT` / `DELETE`.
|
|
117
|
+
*/
|
|
118
|
+
export interface BlueprintResp extends BlueprintResource {
|
|
119
|
+
createdAt: Date;
|
|
120
|
+
updatedAt: Date;
|
|
121
|
+
createdBy: ActorRef;
|
|
122
|
+
publishedAt?: Date;
|
|
123
|
+
publishedBy?: ActorRef;
|
|
124
|
+
contentHash?: string;
|
|
125
|
+
}
|
|
126
|
+
export interface BatchGetBlueprintsReq {
|
|
127
|
+
identifiers: {
|
|
128
|
+
key: string;
|
|
129
|
+
version?: string;
|
|
130
|
+
}[];
|
|
131
|
+
}
|
|
132
|
+
export interface BatchGetBlueprintItem extends BlueprintResp {
|
|
133
|
+
_eTag?: string;
|
|
134
|
+
}
|
|
135
|
+
export interface BatchGetBlueprintsResp {
|
|
136
|
+
data: BatchGetBlueprintItem[];
|
|
137
|
+
}
|
|
138
|
+
export interface RunBlueprintInfo {
|
|
139
|
+
metadata: ResourceMetadata;
|
|
140
|
+
spec: {
|
|
141
|
+
participants?: BlueprintParticipant[];
|
|
142
|
+
inputs?: Input[];
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
export interface CreateBlueprintReq {
|
|
146
|
+
apiVersion?: string;
|
|
147
|
+
metadata: ResourceMetadata;
|
|
148
|
+
spec: BlueprintSpec;
|
|
149
|
+
}
|
|
150
|
+
export interface UpdateBlueprintReq {
|
|
151
|
+
metadata: ResourceMetadata;
|
|
152
|
+
spec: BlueprintSpec;
|
|
153
|
+
}
|
|
154
|
+
export interface PublishBlueprintReq {
|
|
155
|
+
versionType?: VersionType;
|
|
156
|
+
version?: string;
|
|
157
|
+
}
|
|
158
|
+
export interface AddDocumentFromEntities {
|
|
159
|
+
name: string;
|
|
160
|
+
fileId: LiteralOrExpression<string>;
|
|
161
|
+
iterator?: string;
|
|
162
|
+
templateKey?: string;
|
|
163
|
+
templateVersion?: string;
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Unified request for blueprint rendering: POST /blueprints/render
|
|
167
|
+
*
|
|
168
|
+
* @public-api-shape
|
|
169
|
+
* The PUBLIC API surface for this endpoint exposes ONLY the case where the
|
|
170
|
+
* blueprint is already pushed to SignStack. The blueprint is referenced via
|
|
171
|
+
* `?key=&version=` query parameters; the request body carries `entities` and
|
|
172
|
+
* `options` only.
|
|
173
|
+
*
|
|
174
|
+
* The `inlineResources` and `options.inlineOnly` fields are for internal
|
|
175
|
+
* surfaces only (CLI preview from local YAML, Studio scratch renders before
|
|
176
|
+
* push). DO NOT document them in `openapi.json`, public API references,
|
|
177
|
+
* user guides, SDK examples, or LLM-generated content.
|
|
178
|
+
*
|
|
179
|
+
* If you need to expose inline rendering publicly in the future, that should
|
|
180
|
+
* be a deliberate product decision, not an incidental documentation update.
|
|
181
|
+
*/
|
|
182
|
+
export interface RenderBlueprintReq {
|
|
183
|
+
/** Reference an existing blueprint by key. Required when not using `inlineResources.blueprint`. */
|
|
184
|
+
blueprintKey?: string;
|
|
185
|
+
/** Specific version of the referenced blueprint. Defaults to latest published. */
|
|
186
|
+
blueprintVersion?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Which envelope of the blueprint to render. The render system handles
|
|
189
|
+
* one envelope per request; when omitted, the first envelope is used.
|
|
190
|
+
*/
|
|
191
|
+
envelopeKey?: string;
|
|
192
|
+
inlineResources?: {
|
|
193
|
+
blueprint?: BlueprintResource;
|
|
194
|
+
templates?: TemplateResource[];
|
|
195
|
+
assets?: AssetResource[];
|
|
196
|
+
functions?: JsonataFunctionResource[];
|
|
197
|
+
schemas?: SchemaResource[];
|
|
198
|
+
};
|
|
199
|
+
entities?: {
|
|
200
|
+
inputKey: string;
|
|
201
|
+
data: Record<string, any>;
|
|
202
|
+
}[];
|
|
203
|
+
options?: {
|
|
204
|
+
inlineOnly?: boolean;
|
|
205
|
+
skipSignatureFields?: boolean;
|
|
206
|
+
combinePdfs?: boolean;
|
|
207
|
+
/**
|
|
208
|
+
* Whether to stamp the rendered PDF with a "PREVIEW" watermark.
|
|
209
|
+
* Defaults to `true`. Set `false` for production signed renders.
|
|
210
|
+
* @internal
|
|
211
|
+
*/
|
|
212
|
+
addPreviewStamp?: boolean;
|
|
213
|
+
/**
|
|
214
|
+
* Job-wide skip-assigned-fields config. Per-document overrides on
|
|
215
|
+
* `fieldOverridesPerDocument[].skipAssignedFields` take precedence
|
|
216
|
+
* when present for that doc.
|
|
217
|
+
*/
|
|
218
|
+
skipAssignedFields?: {
|
|
219
|
+
scope: 'TextFields' | 'All';
|
|
220
|
+
forRoleKey?: string;
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* Per-document overrides for field values, skipped-assigned-fields,
|
|
224
|
+
* file-id substitution, and pre-computed template fields. Used by the
|
|
225
|
+
* workflow signing flow to express per-doc rendering options without
|
|
226
|
+
* fanning out N requests. `fields` is the legacy overlay-fields list;
|
|
227
|
+
* the other entries are workflow-flow internals.
|
|
228
|
+
* @internal — `fileIdOverride`, `storedTemplateFields`, and per-doc
|
|
229
|
+
* `skipAssignedFields` are not part of the public API surface.
|
|
230
|
+
*/
|
|
231
|
+
fieldOverridesPerDocument?: {
|
|
232
|
+
documentKey: string;
|
|
233
|
+
fields?: OverlayField[];
|
|
234
|
+
/** @internal */
|
|
235
|
+
fileIdOverride?: string;
|
|
236
|
+
/** @internal */
|
|
237
|
+
storedTemplateFields?: TemplateFieldInfo[];
|
|
238
|
+
/** @internal */
|
|
239
|
+
skipAssignedFields?: {
|
|
240
|
+
scope: 'TextFields' | 'All';
|
|
241
|
+
forRoleKey?: string;
|
|
242
|
+
};
|
|
243
|
+
}[];
|
|
244
|
+
};
|
|
245
|
+
}
|
|
246
|
+
export interface RenderedBlueprintDocument {
|
|
247
|
+
key: string;
|
|
248
|
+
name: string;
|
|
249
|
+
/**
|
|
250
|
+
* Short-lived URL to download the rendered PDF directly.
|
|
251
|
+
* The render output is a temporary preview, not a persisted resource —
|
|
252
|
+
* download via this URL or re-render. Do not store as a long-lived reference.
|
|
253
|
+
*/
|
|
254
|
+
signedUrl: string;
|
|
255
|
+
}
|
|
256
|
+
export interface RenderedEnvelope {
|
|
257
|
+
envelopeKey: string;
|
|
258
|
+
documents: RenderedBlueprintDocument[];
|
|
259
|
+
}
|
|
260
|
+
export interface RenderBlueprintResp {
|
|
261
|
+
envelopes: RenderedEnvelope[];
|
|
262
|
+
warnings?: PreviewResourceWarning[];
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Immediate response of `POST /blueprints/render` under the async
|
|
266
|
+
* contract: one background job for the requested (or first) envelope.
|
|
267
|
+
* Callers poll `GET …/render-jobs/:jobId` until terminal, then read the
|
|
268
|
+
* `RenderBlueprintResp` off `GetRenderJobResp.result`. FE/CLI clients do
|
|
269
|
+
* this transparently and still resolve `RenderBlueprintResp` to app code.
|
|
270
|
+
*/
|
|
271
|
+
export interface RenderBlueprintAcceptedResp {
|
|
272
|
+
jobId: string;
|
|
273
|
+
}
|
|
274
|
+
/**
|
|
275
|
+
* @public-api-shape DO-NOT-DOCUMENT
|
|
276
|
+
* The `POST /blueprints/{key}/supported-modes` endpoint is intentionally
|
|
277
|
+
* excluded from `openapi.json` and public API references. The Run/Review
|
|
278
|
+
* workflow-mode model is under reconsideration (Run and Review aren't
|
|
279
|
+
* parallel modes — Review is a "create-but-don't-execute" state, then the
|
|
280
|
+
* caller hits `POST /workflows/{id}/process` to execute). Until the model
|
|
281
|
+
* is reshaped, do not add this endpoint to `openapi.json`, public API
|
|
282
|
+
* references, user guides, SDK examples, or LLM-generated content.
|
|
283
|
+
*
|
|
284
|
+
* Studio still calls this endpoint internally; the runtime contract is
|
|
285
|
+
* unchanged. Only the public surface is suppressed.
|
|
286
|
+
*/
|
|
287
|
+
export interface GetSupportedModesReq {
|
|
288
|
+
version?: string;
|
|
289
|
+
entities: {
|
|
290
|
+
entityKey: string;
|
|
291
|
+
data: Record<string, any>;
|
|
292
|
+
}[];
|
|
293
|
+
}
|
|
294
|
+
/** @public-api-shape DO-NOT-DOCUMENT — see `GetSupportedModesReq`. */
|
|
295
|
+
export interface GetSupportedModesResp {
|
|
296
|
+
supportedModes: CreateWorkflowMode[];
|
|
297
|
+
}
|
|
298
|
+
export interface PreviewResourceWarning {
|
|
299
|
+
resourceId: string;
|
|
300
|
+
message: string;
|
|
301
|
+
source: 'yaml' | 'database';
|
|
302
|
+
}
|
|
303
|
+
export interface FilesLookupReq {
|
|
304
|
+
hashes: string[];
|
|
305
|
+
}
|
|
306
|
+
export interface FilesLookupResp {
|
|
307
|
+
files: {
|
|
308
|
+
hash: string;
|
|
309
|
+
fileId: string | null;
|
|
310
|
+
}[];
|
|
311
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ParticipantTaskType = exports.BlueprintStepCompletionRule = exports.BlueprintStepExecutionMode = exports.BlueprintStepType = void 0;
|
|
4
|
+
const workflow_1 = require("./workflow");
|
|
5
|
+
Object.defineProperty(exports, "ParticipantTaskType", { enumerable: true, get: function () { return workflow_1.ParticipantActionType; } });
|
|
6
|
+
exports.BlueprintStepType = workflow_1.WorkflowStepType;
|
|
7
|
+
exports.BlueprintStepExecutionMode = workflow_1.WorkflowStepExecutionMode;
|
|
8
|
+
exports.BlueprintStepCompletionRule = workflow_1.WorkflowStepCompletionRule;
|
|
9
|
+
//# sourceMappingURL=blueprint.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"blueprint.js","sourceRoot":"","sources":["../../../../../../../../../libs/signstack/base/src/lib/models/blueprint.ts"],"names":[],"mappings":";;;AAAA,yCASoB;AA8Bc,oGAnChC,gCAAqB,OAmC8B;AARxC,QAAA,iBAAiB,GAAG,2BAAgB,CAAC;AAGrC,QAAA,0BAA0B,GAAG,oCAAyB,CAAC;AAGvD,QAAA,2BAA2B,GAAG,qCAA0B,CAAC"}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import type { ListResp } from './base';
|
|
2
|
+
export interface AddSignstackFileReq {
|
|
3
|
+
file: {
|
|
4
|
+
name: string;
|
|
5
|
+
contentType: string;
|
|
6
|
+
/**
|
|
7
|
+
* SHA-256 hash of the file's bytes, hex-encoded. Optional but recommended
|
|
8
|
+
* — supplying it lets the server dedup via `GET /files?hash=…` and gives
|
|
9
|
+
* `POST /files/{id}/verify` a baseline to compare against later. The only
|
|
10
|
+
* supported algorithm.
|
|
11
|
+
*/
|
|
12
|
+
hash?: string;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Internal visibility hint. Public API callers should omit this and always
|
|
16
|
+
* get a private org-scoped upload location. Studio passes `'public'` for
|
|
17
|
+
* brand logo uploads. Not part of the public API contract; defaults to
|
|
18
|
+
* `'private'` when omitted.
|
|
19
|
+
*/
|
|
20
|
+
visibility?: 'public' | 'private';
|
|
21
|
+
}
|
|
22
|
+
export interface AddSignstackFileResp {
|
|
23
|
+
/** Prefixed lowercase ULID, e.g. `f_01jv8m7qfj6xj9gkz7a4s2h8e`. */
|
|
24
|
+
id: string;
|
|
25
|
+
name: string;
|
|
26
|
+
uploadUrl: string;
|
|
27
|
+
}
|
|
28
|
+
export declare enum FileStatus {
|
|
29
|
+
Uploading = "uploading",
|
|
30
|
+
Available = "available"
|
|
31
|
+
}
|
|
32
|
+
export interface FileResp {
|
|
33
|
+
/** Prefixed lowercase ULID, e.g. `f_01jv8m7qfj6xj9gkz7a4s2h8e`. */
|
|
34
|
+
id: string;
|
|
35
|
+
name: string;
|
|
36
|
+
contentType: string;
|
|
37
|
+
size?: number;
|
|
38
|
+
hash?: string;
|
|
39
|
+
hashAlgorithm?: string;
|
|
40
|
+
status: FileStatus;
|
|
41
|
+
createdAt: string;
|
|
42
|
+
updatedAt: string;
|
|
43
|
+
downloadUrl: string;
|
|
44
|
+
}
|
|
45
|
+
export interface FileSummary {
|
|
46
|
+
/** Prefixed lowercase ULID, e.g. `f_01jv8m7qfj6xj9gkz7a4s2h8e`. */
|
|
47
|
+
id: string;
|
|
48
|
+
name: string;
|
|
49
|
+
size?: number;
|
|
50
|
+
status: FileStatus;
|
|
51
|
+
createdAt: string;
|
|
52
|
+
}
|
|
53
|
+
export type ListFilesResp = ListResp<FileSummary>;
|
|
54
|
+
/**
|
|
55
|
+
* Request to verify file integrity using SHA-256 hash
|
|
56
|
+
*/
|
|
57
|
+
export interface VerifyFileHashReq {
|
|
58
|
+
/** Optional hash to verify against stored hash */
|
|
59
|
+
hash?: string;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Response from file hash verification
|
|
63
|
+
*/
|
|
64
|
+
export interface VerifyFileHashResp {
|
|
65
|
+
/** The file ID — prefixed lowercase ULID, e.g. `f_01jv8m7qfj6xj9gkz7a4s2h8e`. */
|
|
66
|
+
id: string;
|
|
67
|
+
/** The stored SHA-256 hash of the file */
|
|
68
|
+
storedHash: string | null;
|
|
69
|
+
/** The algorithm used for hashing (e.g., "SHA-256") */
|
|
70
|
+
hashAlgorithm: string | null;
|
|
71
|
+
/** Whether a hash was provided for verification */
|
|
72
|
+
verified?: boolean;
|
|
73
|
+
/** Whether the provided hash matches the stored hash */
|
|
74
|
+
isMatch?: boolean;
|
|
75
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.FileStatus = void 0;
|
|
4
|
+
var FileStatus;
|
|
5
|
+
(function (FileStatus) {
|
|
6
|
+
FileStatus["Uploading"] = "uploading";
|
|
7
|
+
FileStatus["Available"] = "available";
|
|
8
|
+
})(FileStatus || (exports.FileStatus = FileStatus = {}));
|
|
9
|
+
//# sourceMappingURL=file.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../../../../../../../libs/signstack/base/src/lib/models/file.ts"],"names":[],"mappings":";;;AA8BA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,qCAAuB,CAAA;AACzB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB"}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { ActorRef, ListResp, ResourceListItemBase, ResourceMetadata, VersionType } from './base';
|
|
2
|
+
export interface JsonataFunctionResource {
|
|
3
|
+
metadata: ResourceMetadata;
|
|
4
|
+
spec: JsonataFunctionSpec;
|
|
5
|
+
}
|
|
6
|
+
export interface JsonataFunctionSpec {
|
|
7
|
+
params?: {
|
|
8
|
+
name: string;
|
|
9
|
+
type: JsonataFunctionParamType;
|
|
10
|
+
itemType?: JsonataFunctionItemType;
|
|
11
|
+
schemaKey?: string;
|
|
12
|
+
schemaVersion?: string;
|
|
13
|
+
}[];
|
|
14
|
+
returnType: {
|
|
15
|
+
type: JsonataFunctionParamType;
|
|
16
|
+
itemType?: JsonataFunctionItemType;
|
|
17
|
+
schemaKey?: string;
|
|
18
|
+
schemaVersion?: string;
|
|
19
|
+
};
|
|
20
|
+
body: string;
|
|
21
|
+
functions?: FunctionDependency[];
|
|
22
|
+
}
|
|
23
|
+
export interface JsonataFunctionFormData {
|
|
24
|
+
body: string;
|
|
25
|
+
params?: JsonataFunctionSpec['params'];
|
|
26
|
+
returnType?: JsonataFunctionSpec['returnType'];
|
|
27
|
+
}
|
|
28
|
+
export declare enum JsonataFunctionParamType {
|
|
29
|
+
String = "string",
|
|
30
|
+
Number = "number",
|
|
31
|
+
Boolean = "boolean",
|
|
32
|
+
Object = "object",
|
|
33
|
+
Array = "array"
|
|
34
|
+
}
|
|
35
|
+
export declare enum JsonataFunctionItemType {
|
|
36
|
+
String = "string",
|
|
37
|
+
Number = "number",
|
|
38
|
+
Boolean = "boolean",
|
|
39
|
+
Object = "object"
|
|
40
|
+
}
|
|
41
|
+
export interface ListJsonataFunctionsReq {
|
|
42
|
+
offset?: number;
|
|
43
|
+
limit?: number;
|
|
44
|
+
skipDraft?: boolean;
|
|
45
|
+
search?: string;
|
|
46
|
+
labels?: Record<string, string>;
|
|
47
|
+
}
|
|
48
|
+
export type ListJsonataFunctionsResp = ListResp<JsonataFunctionListItem>;
|
|
49
|
+
export type ListJsonataFunctionVersionsResp = ListResp<JsonataFunctionListItem>;
|
|
50
|
+
export interface JsonataFunctionListItem extends ResourceListItemBase {
|
|
51
|
+
spec: {
|
|
52
|
+
params?: {
|
|
53
|
+
name: string;
|
|
54
|
+
type: JsonataFunctionParamType;
|
|
55
|
+
itemType?: JsonataFunctionItemType;
|
|
56
|
+
schemaKey?: string;
|
|
57
|
+
schemaVersion?: string;
|
|
58
|
+
}[];
|
|
59
|
+
returnType: {
|
|
60
|
+
type: JsonataFunctionParamType;
|
|
61
|
+
itemType?: JsonataFunctionItemType;
|
|
62
|
+
schemaKey?: string;
|
|
63
|
+
schemaVersion?: string;
|
|
64
|
+
};
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Full JSONata function — returned by `GET /jsonata-functions/{key}`,
|
|
69
|
+
* `POST /jsonata-functions`, `PUT .../versions/draft`, and
|
|
70
|
+
* `POST .../versions/draft/publish`. The optimistic-locking handle is
|
|
71
|
+
* returned in the HTTP `ETag` response header (RFC 7232) — pass it back as
|
|
72
|
+
* `If-Match` on the next `PUT` / `DELETE`.
|
|
73
|
+
*/
|
|
74
|
+
export interface JsonataFunctionResp extends JsonataFunctionResource {
|
|
75
|
+
createdAt: Date;
|
|
76
|
+
updatedAt: Date;
|
|
77
|
+
createdBy: ActorRef;
|
|
78
|
+
publishedAt?: Date;
|
|
79
|
+
publishedBy?: ActorRef;
|
|
80
|
+
contentHash?: string;
|
|
81
|
+
}
|
|
82
|
+
export interface CreateJsonataFunctionReq {
|
|
83
|
+
apiVersion?: string;
|
|
84
|
+
metadata: ResourceMetadata;
|
|
85
|
+
spec: JsonataFunctionSpec;
|
|
86
|
+
}
|
|
87
|
+
export interface UpdateJsonataFunctionReq {
|
|
88
|
+
metadata: ResourceMetadata;
|
|
89
|
+
spec: JsonataFunctionSpec;
|
|
90
|
+
}
|
|
91
|
+
export interface PublishJsonataFunctionReq {
|
|
92
|
+
versionType?: VersionType;
|
|
93
|
+
version?: string;
|
|
94
|
+
}
|
|
95
|
+
export interface BatchGetJsonataFunctionsReq {
|
|
96
|
+
identifiers: {
|
|
97
|
+
key: string;
|
|
98
|
+
version?: string;
|
|
99
|
+
}[];
|
|
100
|
+
}
|
|
101
|
+
export interface BatchGetJsonataFunctionItem extends JsonataFunctionResp {
|
|
102
|
+
_eTag?: string;
|
|
103
|
+
}
|
|
104
|
+
export interface BatchGetJsonataFunctionsResp {
|
|
105
|
+
data: BatchGetJsonataFunctionItem[];
|
|
106
|
+
}
|
|
107
|
+
export interface FunctionDependency {
|
|
108
|
+
alias?: string;
|
|
109
|
+
functionKey: string;
|
|
110
|
+
functionVersion: string;
|
|
111
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.JsonataFunctionItemType = exports.JsonataFunctionParamType = void 0;
|
|
4
|
+
var JsonataFunctionParamType;
|
|
5
|
+
(function (JsonataFunctionParamType) {
|
|
6
|
+
JsonataFunctionParamType["String"] = "string";
|
|
7
|
+
JsonataFunctionParamType["Number"] = "number";
|
|
8
|
+
JsonataFunctionParamType["Boolean"] = "boolean";
|
|
9
|
+
JsonataFunctionParamType["Object"] = "object";
|
|
10
|
+
JsonataFunctionParamType["Array"] = "array";
|
|
11
|
+
})(JsonataFunctionParamType || (exports.JsonataFunctionParamType = JsonataFunctionParamType = {}));
|
|
12
|
+
var JsonataFunctionItemType;
|
|
13
|
+
(function (JsonataFunctionItemType) {
|
|
14
|
+
JsonataFunctionItemType["String"] = "string";
|
|
15
|
+
JsonataFunctionItemType["Number"] = "number";
|
|
16
|
+
JsonataFunctionItemType["Boolean"] = "boolean";
|
|
17
|
+
JsonataFunctionItemType["Object"] = "object";
|
|
18
|
+
})(JsonataFunctionItemType || (exports.JsonataFunctionItemType = JsonataFunctionItemType = {}));
|
|
19
|
+
//# sourceMappingURL=jsonata-function.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jsonata-function.js","sourceRoot":"","sources":["../../../../../../../../../libs/signstack/base/src/lib/models/jsonata-function.ts"],"names":[],"mappings":";;;AAqCA,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,6CAAiB,CAAA;IACjB,6CAAiB,CAAA;IACjB,+CAAmB,CAAA;IACnB,6CAAiB,CAAA;IACjB,2CAAe,CAAA;AACjB,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,4CAAiB,CAAA;IACjB,4CAAiB,CAAA;IACjB,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;AACnB,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC"}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import { PaginationDto } from './base';
|
|
2
|
+
import { ResourceKind } from './resource-edge';
|
|
3
|
+
import { ScenarioEntity } from './scenario';
|
|
4
|
+
export type MarketplaceResourceKind = ResourceKind.Blueprint | ResourceKind.Template;
|
|
5
|
+
export declare enum MarketplaceListingScope {
|
|
6
|
+
Public = "public",
|
|
7
|
+
Org = "org"
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Per-organization access grant. `namespaceKeys` is either an explicit list of
|
|
11
|
+
* namespace keys inside that org, or the wildcard `'*'` meaning "all namespaces
|
|
12
|
+
* of this org".
|
|
13
|
+
*/
|
|
14
|
+
export interface ListingAccessGrant {
|
|
15
|
+
orgId: string;
|
|
16
|
+
namespaceKeys: string[] | '*';
|
|
17
|
+
}
|
|
18
|
+
export interface CreateMarketplaceListingReq {
|
|
19
|
+
key: string;
|
|
20
|
+
resourceKey: string;
|
|
21
|
+
resourceVersion: string;
|
|
22
|
+
resourceType: MarketplaceResourceKind;
|
|
23
|
+
title: string;
|
|
24
|
+
description: string;
|
|
25
|
+
tags?: string[];
|
|
26
|
+
scope: MarketplaceListingScope;
|
|
27
|
+
/** Required when `scope === 'org'`; omit/empty for `'public'`. */
|
|
28
|
+
accessGrants?: ListingAccessGrant[];
|
|
29
|
+
}
|
|
30
|
+
export interface ListMarketplaceListingsReq {
|
|
31
|
+
offset?: number;
|
|
32
|
+
limit?: number;
|
|
33
|
+
}
|
|
34
|
+
export interface ListMarketplaceListingsResp {
|
|
35
|
+
data: MarketplaceListingDto[];
|
|
36
|
+
pagination: PaginationDto;
|
|
37
|
+
}
|
|
38
|
+
export interface LibraryDependencyNode {
|
|
39
|
+
kind: string;
|
|
40
|
+
key: string;
|
|
41
|
+
version: string;
|
|
42
|
+
children: LibraryDependencyNode[];
|
|
43
|
+
}
|
|
44
|
+
export interface GetLibraryDependencyTreeResp {
|
|
45
|
+
tree: LibraryDependencyNode;
|
|
46
|
+
}
|
|
47
|
+
export interface ResourceCounts {
|
|
48
|
+
blueprints?: number;
|
|
49
|
+
templates?: number;
|
|
50
|
+
assets?: number;
|
|
51
|
+
schemas?: number;
|
|
52
|
+
functions?: number;
|
|
53
|
+
}
|
|
54
|
+
export interface ListingPreviewFile {
|
|
55
|
+
fileId: string;
|
|
56
|
+
scenarioKey: string;
|
|
57
|
+
fileName: string;
|
|
58
|
+
scenarioName: string;
|
|
59
|
+
}
|
|
60
|
+
export interface ListingHeroImage {
|
|
61
|
+
fileId: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Generation state of a listing's scenario previews. Publishing returns
|
|
65
|
+
* immediately (202) with `pending`; per-scenario renders run as background
|
|
66
|
+
* jobs and the state flips to `ready` once all previews + hero image are
|
|
67
|
+
* generated. `failed` is reserved for a hard finalization failure. The
|
|
68
|
+
* library UI polls the listing until this is terminal.
|
|
69
|
+
*/
|
|
70
|
+
export declare enum ListingPreviewsStatus {
|
|
71
|
+
Pending = "pending",
|
|
72
|
+
Ready = "ready",
|
|
73
|
+
Failed = "failed"
|
|
74
|
+
}
|
|
75
|
+
export interface ListingScenarioDto {
|
|
76
|
+
key: string;
|
|
77
|
+
name: string;
|
|
78
|
+
description?: string;
|
|
79
|
+
entities: ScenarioEntity[];
|
|
80
|
+
createdAt: Date;
|
|
81
|
+
updatedAt: Date;
|
|
82
|
+
}
|
|
83
|
+
export interface MarketplaceListingDto {
|
|
84
|
+
key: string;
|
|
85
|
+
version: string;
|
|
86
|
+
resourceKey: string;
|
|
87
|
+
resourceVersion: string;
|
|
88
|
+
resourceType: MarketplaceResourceKind;
|
|
89
|
+
orgId: string;
|
|
90
|
+
namespaceKey: string;
|
|
91
|
+
title: string;
|
|
92
|
+
description: string;
|
|
93
|
+
previewFiles?: ListingPreviewFile[];
|
|
94
|
+
heroImage?: ListingHeroImage;
|
|
95
|
+
/**
|
|
96
|
+
* Background preview-generation state. `pending` right after publish;
|
|
97
|
+
* `ready` once all scenario previews + hero image are generated. Absent
|
|
98
|
+
* on legacy listings created before async previews — treat as `ready`.
|
|
99
|
+
*/
|
|
100
|
+
previewsStatus?: ListingPreviewsStatus;
|
|
101
|
+
tags?: string[];
|
|
102
|
+
resourceCounts?: ResourceCounts;
|
|
103
|
+
scope: MarketplaceListingScope;
|
|
104
|
+
accessGrants?: ListingAccessGrant[];
|
|
105
|
+
createdAt: Date;
|
|
106
|
+
updatedAt: Date;
|
|
107
|
+
}
|
|
108
|
+
export interface ListingVersionSummary {
|
|
109
|
+
version: string;
|
|
110
|
+
resourceVersion: string;
|
|
111
|
+
createdAt: Date;
|
|
112
|
+
}
|
|
113
|
+
export interface ListListingVersionsResp {
|
|
114
|
+
key: string;
|
|
115
|
+
versions: ListingVersionSummary[];
|
|
116
|
+
}
|
|
117
|
+
export interface PrepareListingReq {
|
|
118
|
+
resourceKey: string;
|
|
119
|
+
resourceVersion: string;
|
|
120
|
+
resourceType: MarketplaceResourceKind;
|
|
121
|
+
}
|
|
122
|
+
export interface PrepareListingResp {
|
|
123
|
+
listingKey: string;
|
|
124
|
+
currentVersion: string | null;
|
|
125
|
+
projectedVersion: string;
|
|
126
|
+
title: string;
|
|
127
|
+
description: string;
|
|
128
|
+
tags: string[];
|
|
129
|
+
isExisting: boolean;
|
|
130
|
+
scope: MarketplaceListingScope;
|
|
131
|
+
accessGrants: ListingAccessGrant[];
|
|
132
|
+
}
|