@scalar/workspace-store 0.49.3 → 0.51.0

package/dist/schemas/asyncapi/asyncapi-document.d.ts

@@ -0,0 +1,79 @@
+import { WorkspaceManagedExtensions } from '../../schemas/extensions/document/workspace-managed-extensions.js';
+import { XScalarIsDirty } from '../../schemas/extensions/document/x-scalar-is-dirty.js';
+import { XScalarOriginalDocumentHash } from '../../schemas/extensions/document/x-scalar-original-document-hash.js';
+import { XScalarRegistryMeta } from '../../schemas/extensions/document/x-scalar-registry-meta.js';
+/**
+ * Minimal AsyncAPI Info Object.
+ *
+ * Intentionally scoped to the fields we surface in the MVP. AsyncAPI's real Info Object
+ * is a superset (contact, license, termsOfService, tags, externalDocs, ...) — we can
+ * grow this as consumers need the extra fields.
+ */
+export declare const AsyncApiInfoObject: import("@scalar/validation").ObjectSchema<{
+    title: import("@scalar/validation").StringSchema;
+    version: import("@scalar/validation").StringSchema;
+    description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>;
+export type AsyncApiInfoObject = {
+    /** REQUIRED. The title of the application. */
+    title: string;
+    /** REQUIRED. Provides the version of the application API (not the AsyncAPI Specification version). */
+    version: string;
+    /** A short description of the application. CommonMark syntax can be used for rich text representation. */
+    description?: string;
+};
+/**
+ * AsyncAPI-specific extensions. Store-managed metadata (source url, document
+ * hash, dirty flag, registry meta) is shared with the OpenAPI side via the
+ * dedicated extension modules so the two cannot drift apart.
+ *
+ * `x-original-aas-version` stays here because it is the AsyncAPI analog of
+ * `x-original-oas-version` — different field names per spec, so unified
+ * sharing is not a fit.
+ */
+export declare const AsyncApiExtensions: import("@scalar/validation").ObjectSchema<{
+    'x-original-aas-version': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>;
+export type AsyncApiExtensions = Partial<{
+    /** Original AsyncAPI Specification version the document was loaded with. */
+    'x-original-aas-version': string;
+}>;
+/**
+ * Minimal AsyncAPI Document.
+ *
+ * MVP shape: the spec version discriminator, the minimal Info Object, and the shared
+ * store-managed metadata extensions. Present on the discriminated {@link WorkspaceDocument}
+ * union via the required `asyncapi` field.
+ */
+export declare const AsyncApiDocument: import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
+    asyncapi: import("@scalar/validation").StringSchema;
+    info: import("@scalar/validation").ObjectSchema<{
+        title: import("@scalar/validation").StringSchema;
+        version: import("@scalar/validation").StringSchema;
+        description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+    }>;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-original-aas-version': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-scalar-original-source-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-scalar-original-document-hash': import("@scalar/validation").StringSchema;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-scalar-is-dirty': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
+}>, import("@scalar/validation").ObjectSchema<{
+    'x-scalar-registry-meta': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
+        namespace: import("@scalar/validation").StringSchema;
+        slug: import("@scalar/validation").StringSchema;
+        version: import("@scalar/validation").StringSchema;
+        commitHash: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        conflictCheckedAgainstHash: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+        hasConflict: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
+    }>>;
+}>]>;
+export type AsyncApiDocument = {
+    /** REQUIRED. The AsyncAPI Specification version the document uses (for example "3.0.0"). */
+    asyncapi: string;
+    /** REQUIRED. Provides metadata about the application. */
+    info: AsyncApiInfoObject;
+} & AsyncApiExtensions & WorkspaceManagedExtensions & XScalarOriginalDocumentHash & XScalarIsDirty & XScalarRegistryMeta;
+//# sourceMappingURL=asyncapi-document.d.ts.map

package/dist/schemas/asyncapi/asyncapi-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncapi-document.d.ts","sourceRoot":"","sources":["../../../src/schemas/asyncapi/asyncapi-document.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,0BAA0B,EAAE,MAAM,4DAA4D,CAAA;AACvG,OAAO,EAAE,cAAc,EAAE,MAAM,iDAAiD,CAAA;AAChF,OAAO,EAAE,2BAA2B,EAAE,MAAM,+DAA+D,CAAA;AAC3G,OAAO,EAAE,mBAAmB,EAAE,MAAM,sDAAsD,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;EAc9B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAA;IACb,sGAAsG;IACtG,OAAO,EAAE,MAAM,CAAA;IACf,0GAA0G;IAC1G,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;;EAO9B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;IACvC,4EAA4E;IAC5E,wBAAwB,EAAE,MAAM,CAAA;CACjC,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;IAuB5B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAA;IAChB,yDAAyD;IACzD,IAAI,EAAE,kBAAkB,CAAA;CACzB,GAAG,kBAAkB,GACpB,0BAA0B,GAC1B,2BAA2B,GAC3B,cAAc,GACd,mBAAmB,CAAA"}

package/dist/schemas/asyncapi/asyncapi-document.js

@@ -0,0 +1,58 @@
+import { intersection, object, optional, string } from '@scalar/validation';
+import { WorkspaceManagedExtensions } from '../../schemas/extensions/document/workspace-managed-extensions.js';
+import { XScalarIsDirty } from '../../schemas/extensions/document/x-scalar-is-dirty.js';
+import { XScalarOriginalDocumentHash } from '../../schemas/extensions/document/x-scalar-original-document-hash.js';
+import { XScalarRegistryMeta } from '../../schemas/extensions/document/x-scalar-registry-meta.js';
+/**
+ * Minimal AsyncAPI Info Object.
+ *
+ * Intentionally scoped to the fields we surface in the MVP. AsyncAPI's real Info Object
+ * is a superset (contact, license, termsOfService, tags, externalDocs, ...) — we can
+ * grow this as consumers need the extra fields.
+ */
+export const AsyncApiInfoObject = object({
+    title: string({ typeComment: 'REQUIRED. The title of the application.' }),
+    version: string({
+        typeComment: 'REQUIRED. Provides the version of the application API (not the AsyncAPI Specification version).',
+    }),
+    description: optional(string({
+        typeComment: 'A short description of the application. CommonMark syntax can be used for rich text representation.',
+    })),
+}, { typeName: 'AsyncApiInfoObject' });
+/**
+ * AsyncAPI-specific extensions. Store-managed metadata (source url, document
+ * hash, dirty flag, registry meta) is shared with the OpenAPI side via the
+ * dedicated extension modules so the two cannot drift apart.
+ *
+ * `x-original-aas-version` stays here because it is the AsyncAPI analog of
+ * `x-original-oas-version` — different field names per spec, so unified
+ * sharing is not a fit.
+ */
+export const AsyncApiExtensions = object({
+    'x-original-aas-version': optional(string({ typeComment: 'Original AsyncAPI Specification version the document was loaded with.' })),
+}, { typeName: 'AsyncApiExtensions' });
+/**
+ * Minimal AsyncAPI Document.
+ *
+ * MVP shape: the spec version discriminator, the minimal Info Object, and the shared
+ * store-managed metadata extensions. Present on the discriminated {@link WorkspaceDocument}
+ * union via the required `asyncapi` field.
+ */
+export const AsyncApiDocument = intersection([
+    object({
+        asyncapi: string({
+            typeComment: 'REQUIRED. The AsyncAPI Specification version the document uses (for example "3.0.0").',
+        }),
+        info: AsyncApiInfoObject,
+    }, { typeName: 'AsyncApiDocumentCore' }),
+    AsyncApiExtensions,
+    // Shared store-managed metadata. Composed from the same extension modules
+    // the OpenAPI side uses so the two document shapes cannot drift apart.
+    WorkspaceManagedExtensions,
+    XScalarOriginalDocumentHash,
+    XScalarIsDirty,
+    XScalarRegistryMeta,
+], {
+    typeName: 'AsyncApiDocument',
+    typeComment: 'Root AsyncAPI document including Scalar workspace extensions.',
+});

package/dist/schemas/extensions/document/workspace-managed-extensions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Schema for workspace-store-managed metadata extensions that apply to every
+ * document type in the workspace, regardless of OpenAPI or AsyncAPI shape.
+ *
+ * Currently this is just `x-scalar-original-source-url`. The original document
+ * hash (`x-scalar-original-document-hash`) is intentionally kept in its own
+ * `XScalarOriginalDocumentHashSchema` because OpenAPI treats it as
+ * post-ingestion-required (so `coerce` defaults missing values to `""`),
+ * while AsyncAPI treats it as optional. Once that asymmetry is resolved this
+ * file can absorb it.
+ *
+ * Centralized here so the OpenAPI and AsyncAPI document schemas share one
+ * definition for the source-url field and cannot drift apart silently.
+ */
+export declare const WorkspaceManagedExtensionsSchema: import("@scalar/typebox").TObject<{
+    'x-scalar-original-source-url': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
+}>;
+export type WorkspaceManagedExtensions = Partial<{
+    /** Original document source url — when loaded from an external source. */
+    'x-scalar-original-source-url': string;
+}>;
+export declare const WorkspaceManagedExtensions: import("@scalar/validation").ObjectSchema<{
+    'x-scalar-original-source-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
+}>;
+//# sourceMappingURL=workspace-managed-extensions.d.ts.map

package/dist/schemas/extensions/document/workspace-managed-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-managed-extensions.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/workspace-managed-extensions.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gCAAgC;;EAK5C,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;IAC/C,0EAA0E;IAC1E,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAC,CAAA;AAEF,eAAO,MAAM,0BAA0B;;EAUtC,CAAA"}

package/dist/schemas/extensions/document/workspace-managed-extensions.js

@@ -0,0 +1,26 @@
+import { Type } from '@scalar/typebox';
+import { object, optional, string } from '@scalar/validation';
+/**
+ * Schema for workspace-store-managed metadata extensions that apply to every
+ * document type in the workspace, regardless of OpenAPI or AsyncAPI shape.
+ *
+ * Currently this is just `x-scalar-original-source-url`. The original document
+ * hash (`x-scalar-original-document-hash`) is intentionally kept in its own
+ * `XScalarOriginalDocumentHashSchema` because OpenAPI treats it as
+ * post-ingestion-required (so `coerce` defaults missing values to `""`),
+ * while AsyncAPI treats it as optional. Once that asymmetry is resolved this
+ * file can absorb it.
+ *
+ * Centralized here so the OpenAPI and AsyncAPI document schemas share one
+ * definition for the source-url field and cannot drift apart silently.
+ */
+export const WorkspaceManagedExtensionsSchema = Type.Partial(Type.Object({
+    /** Original document source url — when loaded from an external source. */
+    'x-scalar-original-source-url': Type.String(),
+}));
+export const WorkspaceManagedExtensions = object({
+    'x-scalar-original-source-url': optional(string({ typeComment: 'Original document source url — when loaded from an external source.' })),
+}, {
+    typeName: 'WorkspaceManagedExtensions',
+    typeComment: 'Workspace-store-managed metadata extensions shared by OpenAPI and AsyncAPI documents.',
+});