@scalar/oas-utils 0.2.58 → 0.2.59

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/oas-utils
 
+## 0.2.59
+
+### Patch Changes
+
+- 4e50d65: feat: added openapi watcher to live update the api client
+- Updated dependencies [6bbb815]
+  - @scalar/themes@0.9.40
+
 ## 0.2.58
 
 ### Patch Changes

package/dist/diff/diff.js

@@ -0,0 +1,40 @@
+import microdiff from 'microdiff';
+
+const types = {
+    CREATE: 'add',
+    REMOVE: 'remove',
+    CHANGE: 'modify',
+};
+/**
+ * Compare two specs and return the changes for each request entry
+ *
+ */
+function diffSpec(a, b) {
+    const diff = microdiff(a, b);
+    const requestChanges = {};
+    diff
+        .filter((d) => d.path[0] === 'paths')
+        .forEach((d) => {
+        const key = d.path
+            .slice(0, 3)
+            .map((p) => String(p).replaceAll('/', '~1'))
+            .join('/');
+        if (!requestChanges[key])
+            requestChanges[key] = {
+                type: types[d.type],
+                mutations: [],
+            };
+        if (d.type === 'CHANGE') {
+            requestChanges[key].mutations.push({
+                ...d,
+                path: d.path.slice(3),
+            });
+        }
+        else if (d.type === 'CREATE') {
+            requestChanges[key].value = d.value;
+        }
+    });
+    return JSON.stringify(requestChanges, null, 2);
+}
+
+export { diffSpec };

package/dist/diff/index.d.ts

@@ -1 +1,2 @@
+export * from './diff.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/diff/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/diff/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/diff/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA"}

package/dist/diff/index.js

@@ -1 +1 @@
-
+export { diffSpec } from './diff.js';

package/dist/entities/spec/collection.d.ts

@@ -98,6 +98,20 @@ export declare const extendedCollectionSchema: z.ZodObject<{
         token?: string | undefined;
         clientSecret?: string | undefined;
     }>]>>>;
+    /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
+    documentUrl: z.ZodOptional<z.ZodString>;
+    /**
+     * Enables polling of OpenAPI document urls
+     *
+     * @remarks Only effective when `documentUrl` is set
+     */
+    watchForChanges: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    /**
+     * Status of the watcher from above
+     *
+     * @defaults to idle for all collections, doesn't mean that it can watch for changes
+     */
+    watchForChangesStatus: z.ZodDefault<z.ZodOptional<z.ZodEnum<["IDLE", "WATCHING", "ERROR"]>>>;
 }, "strip", z.ZodTypeAny, {
     uid: string;
     children: string[];
@@ -133,6 +147,9 @@ export declare const extendedCollectionSchema: z.ZodObject<{
         token: string;
         clientSecret: string;
     }>;
+    watchForChanges: boolean;
+    watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
+    documentUrl?: string | undefined;
 }, {
     uid?: string | undefined;
     children?: (string | undefined)[] | undefined;
@@ -168,6 +185,9 @@ export declare const extendedCollectionSchema: z.ZodObject<{
         token?: string | undefined;
         clientSecret?: string | undefined;
     }> | undefined;
+    documentUrl?: string | undefined;
+    watchForChanges?: boolean | undefined;
+    watchForChangesStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
 }>;
 export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"collection">>>;
@@ -361,6 +381,20 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
         token?: string | undefined;
         clientSecret?: string | undefined;
     }>]>>>;
+    /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
+    documentUrl: z.ZodOptional<z.ZodString>;
+    /**
+     * Enables polling of OpenAPI document urls
+     *
+     * @remarks Only effective when `documentUrl` is set
+     */
+    watchForChanges: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    /**
+     * Status of the watcher from above
+     *
+     * @defaults to idle for all collections, doesn't mean that it can watch for changes
+     */
+    watchForChangesStatus: z.ZodDefault<z.ZodOptional<z.ZodEnum<["IDLE", "WATCHING", "ERROR"]>>>;
 }>, "strip", z.ZodTypeAny, {
     type: "collection";
     uid: string;
@@ -400,6 +434,8 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
         token: string;
         clientSecret: string;
     }>;
+    watchForChanges: boolean;
+    watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
     externalDocs?: {
         url: string;
         description?: string | undefined;
@@ -424,6 +460,7 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
     } | undefined;
     components?: Record<string, unknown> | undefined;
     webhooks?: Record<string, unknown> | undefined;
+    documentUrl?: string | undefined;
 }, {
     type?: "collection" | undefined;
     uid?: string | undefined;
@@ -487,6 +524,9 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
         token?: string | undefined;
         clientSecret?: string | undefined;
     }> | undefined;
+    documentUrl?: string | undefined;
+    watchForChanges?: boolean | undefined;
+    watchForChangesStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
 }>;
 export type Collection = z.infer<typeof collectionSchema>;
 export type CollectionPayload = z.input<typeof collectionSchema>;

package/dist/entities/spec/collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAyCvB,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA9C3B;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;IAYhD,qEAAqE;;IAErE,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAyCvB,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA/D3B;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;IAYhD,qEAAqE;;IAErE,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH,wGAAwG;;IAExG;;;;OAIG;;IAEH;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/entities/spec/collection.js

@@ -59,6 +59,23 @@ const extendedCollectionSchema = z.object({
      * The entry will contain the secret values (but not the schema definition)
      */
     auth: z.record(nanoidSchema, securitySchemeExampleValueSchema).default({}),
+    /** A link to where this document is stored, useful for live sync and possibly git sync down the line */
+    documentUrl: z.string().optional(),
+    /**
+     * Enables polling of OpenAPI document urls
+     *
+     * @remarks Only effective when `documentUrl` is set
+     */
+    watchForChanges: z.boolean().optional().default(false),
+    /**
+     * Status of the watcher from above
+     *
+     * @defaults to idle for all collections, doesn't mean that it can watch for changes
+     */
+    watchForChangesStatus: z
+        .enum(['IDLE', 'WATCHING', 'ERROR'])
+        .optional()
+        .default('IDLE'),
 });
 const collectionSchema = oasCollectionSchema.merge(extendedCollectionSchema);
 

package/dist/entities/spec/index.js

@@ -4,4 +4,4 @@ export { oasRequestSchema, requestMethods, requestSchema } from './requests.js';
 export { createExampleFromRequest, createParamInstance, exampleRequestBodyEncoding, exampleRequestBodySchema, requestExampleParametersSchema, requestExampleSchema } from './request-examples.js';
 export { oasContactSchema, oasExternalDocumentationSchema, oasInfoSchema, oasLicenseSchema, oasTagSchema, tagSchema, xScalarNestedSchema } from './spec-objects.js';
 export { oasParameterSchema, parameterStyleSchema, parameterTypeSchema } from './parameters.js';
-export { authExampleFromSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema } from './security.js';
+export { authExampleFromSchema, oasOauthFlowSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema } from './security.js';

package/dist/entities/spec/security.d.ts

@@ -210,6 +210,124 @@ export declare const securityOpenIdSchema: z.ZodObject<z.objectUtil.extendShape<
     openIdConnectUrl?: string | undefined;
 }>;
 export type SecuritySchemaOpenId = z.infer<typeof securityOpenIdSchema>;
+export declare const oasOauthFlowSchema: z.ZodDefault<z.ZodOptional<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    refreshUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    scopes: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodMap<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
+    selectedScopes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, {
+    type: z.ZodLiteral<"implicit">;
+    authorizationUrl: z.ZodDefault<z.ZodString>;
+    'x-scalar-redirect-uri': z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    type: "implicit";
+    refreshUrl: string;
+    scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
+    selectedScopes: string[];
+    authorizationUrl: string;
+    'x-scalar-redirect-uri': string;
+}, {
+    type: "implicit";
+    refreshUrl?: string | undefined;
+    scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
+    selectedScopes?: string[] | undefined;
+    authorizationUrl?: string | undefined;
+    'x-scalar-redirect-uri'?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    refreshUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    scopes: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodMap<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
+    selectedScopes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, {
+    type: z.ZodLiteral<"password">;
+    tokenUrl: z.ZodDefault<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: "password";
+    refreshUrl: string;
+    scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
+    selectedScopes: string[];
+    tokenUrl: string;
+}, {
+    type: "password";
+    refreshUrl?: string | undefined;
+    scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
+    selectedScopes?: string[] | undefined;
+    tokenUrl?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    refreshUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    scopes: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodMap<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
+    selectedScopes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, {
+    type: z.ZodLiteral<"clientCredentials">;
+    tokenUrl: z.ZodDefault<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: "clientCredentials";
+    refreshUrl: string;
+    scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
+    selectedScopes: string[];
+    tokenUrl: string;
+}, {
+    type: "clientCredentials";
+    refreshUrl?: string | undefined;
+    scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
+    selectedScopes?: string[] | undefined;
+    tokenUrl?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
+     * URL. The OAuth2 standard requires the use of TLS.
+     */
+    refreshUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    /**
+     * REQUIRED. The available scopes for the OAuth2 security scheme. A map
+     * between the scope name and a short description for it. The map MAY be empty.
+     */
+    scopes: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodMap<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>]>>>;
+    selectedScopes: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
+}, {
+    type: z.ZodLiteral<"authorizationCode">;
+    authorizationUrl: z.ZodDefault<z.ZodString>;
+    'x-scalar-redirect-uri': z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    tokenUrl: z.ZodDefault<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: "authorizationCode";
+    refreshUrl: string;
+    scopes: Map<string, string | undefined> | Record<string, string | undefined> | {};
+    selectedScopes: string[];
+    authorizationUrl: string;
+    'x-scalar-redirect-uri': string;
+    tokenUrl: string;
+}, {
+    type: "authorizationCode";
+    refreshUrl?: string | undefined;
+    scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
+    selectedScopes?: string[] | undefined;
+    authorizationUrl?: string | undefined;
+    'x-scalar-redirect-uri'?: string | undefined;
+    tokenUrl?: string | undefined;
+}>]>>>;
 export declare const securityOauthSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     description: z.ZodOptional<z.ZodString>;
 }, {

package/dist/entities/spec/security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA6CvB;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAO3C,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,gCAAgC,CACxC,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,gCAAgC,GAAG,OAAO,CACpD,0BAA0B,EAC1B;IAAE,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,UAAU,GAAE,GAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBrB;AAoBD,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAU5E,eAAO,MAAM,oBAAoB;;;;IAN/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;EAmB3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AA4BvE,eAAO,MAAM,kBAAkB;;;;IArB7B;;;OAGG;;IAOH;;;;OAIG;;;;IAzCH,0EAA0E;;;;;;;;;;;;;;;;EAkD3E,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IA5DH,0EAA0E;;;;;;;;;;;;;;EAkE3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AA2EvE,eAAO,MAAM,mBAAmB;;;;IAN9B,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IA1IpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgJ3E,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAKtE;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAGxC,CAAA;AAED,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IA5JlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAc7F;;;OAGG;;IAOH;;;;OAIG;;;;;;;;;;;;;;;;IA+FH,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAjFpE;;;OAGG;;;;;;;;;;IAgHH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IApK/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;IA2B1E;;;OAGG;;IAOH;;;;OAIG;;;;IAzCH,0EAA0E;;;;;;;;;;;;;;;;;;;;IAyD1E;;;OAGG;;;;IA5DH,0EAA0E;;;;;;;;;;;;;;;;;;IAwI1E,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IA1IpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoL1E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA6CvB;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAO3C,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,gCAAgC,CACxC,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,gCAAgC,GAAG,OAAO,CACpD,0BAA0B,EAC1B;IAAE,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAC5B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,UAAU,GAAE,GAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;EAiBrB;AAoBD,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAU5E,eAAO,MAAM,oBAAoB;;;;IAN/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;EAmB3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AA4BvE,eAAO,MAAM,kBAAkB;;;;IArB7B;;;OAGG;;IAOH;;;;OAIG;;;;IAzCH,0EAA0E;;;;;;;;;;;;;;;;EAkD3E,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IA5DH,0EAA0E;;;;;;;;;;;;;;EAkE3E,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAsCvE,eAAO,MAAM,kBAAkB;IApB7B;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;IARH;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;IARH;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;IARH;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;MAuCsE,CAAA;AAU3E,eAAO,MAAM,mBAAmB;;;;IAN9B,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IA1IpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgJ3E,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAKtE;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAGxC,CAAA;AAED,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IA5JlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAc7F;;;OAGG;;IAOH;;;;OAIG;;;;;;;;;;;;;;;;IA+FH,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAjFpE;;;OAGG;;;;;;;;;;IAgHH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IApK/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;IA2B1E;;;OAGG;;IAOH;;;;OAIG;;;;IAzCH,0EAA0E;;;;;;;;;;;;;;;;;;;;IAyD1E;;;OAGG;;;;IA5DH,0EAA0E;;;;;;;;;;;;;;;;;;IAwI1E,6FAA6F;;QAnD7F;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;QARH;;;WAGG;;QAEH;;;WAGG;;;;;;;;;;;;;;;;;;;;;;;;;IA6CH,oEAAoE;;;;IA1IpE,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoL1E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}

package/dist/entities/spec/security.js

@@ -224,4 +224,4 @@ const securitySchemeSchema = z.union([
     securityOauthSchema,
 ]);
 
-export { authExampleFromSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema };
+export { authExampleFromSchema, oasOauthFlowSchema, oasSecurityRequirementSchema, oasSecuritySchemeSchema, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeExampleValueSchema, securitySchemeSchema };

package/dist/entities/spec/server.d.ts

@@ -17,7 +17,7 @@ export declare const oasServerSchema: z.ZodObject<{
      * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
      * will be made when a variable is named in {brackets}.
      */
-    url: z.ZodOptional<z.ZodString>;
+    url: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     /**
      * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
      * representation.
@@ -30,8 +30,8 @@ export declare const oasServerSchema: z.ZodObject<{
         enum?: [string, ...string[]];
     }>>>;
 }, "strip", z.ZodTypeAny, {
+    url: string;
     description?: string | undefined;
-    url?: string | undefined;
     variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
         enum?: [string, ...string[]];
     }> | undefined;
@@ -48,7 +48,7 @@ export declare const serverSchema: z.ZodObject<z.objectUtil.extendShape<{
      * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
      * will be made when a variable is named in {brackets}.
      */
-    url: z.ZodOptional<z.ZodString>;
+    url: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     /**
      * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
      * representation.
@@ -64,8 +64,8 @@ export declare const serverSchema: z.ZodObject<z.objectUtil.extendShape<{
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }>, "strip", z.ZodTypeAny, {
     uid: string;
+    url: string;
     description?: string | undefined;
-    url?: string | undefined;
     variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
         enum?: [string, ...string[]];
     }> | undefined;

package/dist/entities/spec/server.js

@@ -30,7 +30,7 @@ const oasServerSchema = z.object({
      * the host location is relative to the location where the OpenAPI document is being served. Variable substitutions
      * will be made when a variable is named in {brackets}.
      */
-    url: z.string().optional(),
+    url: z.string().optional().default(''),
     /**
      * An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text
      * representation.

package/dist/helpers/fetchSpecFromUrl.d.ts

@@ -3,5 +3,5 @@
  *
  * @throws an error if the fetch fails
  */
-export declare function fetchSpecFromUrl(url: string, proxy?: string): Promise<string>;
+export declare function fetchSpecFromUrl(url: string, proxy?: string, beautify?: boolean): Promise<string>;
 //# sourceMappingURL=fetchSpecFromUrl.d.ts.map

package/dist/helpers/fetchSpecFromUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchSpecFromUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/fetchSpecFromUrl.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,CAAC,CA6BjB"}
+{"version":3,"file":"fetchSpecFromUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/fetchSpecFromUrl.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,UAAO,GACd,OAAO,CAAC,MAAM,CAAC,CA8BjB"}

package/dist/helpers/fetchSpecFromUrl.js

@@ -10,7 +10,7 @@ const NEW_PROXY_URL = 'https://proxy.scalar.com';
  *
  * @throws an error if the fetch fails
  */
-async function fetchSpecFromUrl(url, proxy) {
+async function fetchSpecFromUrl(url, proxy, beautify = true) {
     // This replaces the OLD_PROXY_URL with the NEW_PROXY_URL on the fly.
     if (proxy === OLD_PROXY_URL) {
         // eslint-disable-next-line no-param-reassign
@@ -27,7 +27,10 @@ async function fetchSpecFromUrl(url, proxy) {
         throw new Error(`Failed to fetch the specification (Status: ${response.status})`);
     }
     // If it’s JSON, make it pretty
-    return formatJsonOrYamlString(await response.text());
+    if (beautify)
+        return formatJsonOrYamlString(await response.text());
+    else
+        return await response.text();
 }
 
 export { fetchSpecFromUrl };

package/dist/migrations/v-2.1.0/migration.d.ts

@@ -63,6 +63,8 @@ export declare const migrate_v_2_1_0: (data: Omit<v_0_0_0.Data, "folders">) => {
         }>;
         children: string[];
         'x-scalar-icon': string;
+        watchForChanges: false;
+        watchForChangesStatus: "IDLE";
     }[];
     cookies: v_0_0_0.Cookie[];
     environments: {

package/dist/migrations/v-2.1.0/migration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAInE,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;;;;;;;;;;oBAG/C,CAAC;mBAIjB,CADJ;qBAA4C,CAAC;;;;0BAKlC,CAAC;mBACR,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiDsD,CAAC;;;;oBASlD,CAAC;;;;;;wBAIF,CAAR;;;;;;sCAM2B,GAAG;oHAMoB,GAAsB;iCAGhE,GAAC;+BACS,GAAG;;+BAKb,CAAC;0BAED,CAAC;4BAIY,CAAA;wBAAoC,CAAC;wBAAqC,CAAC;0BACpF,CAAC;2BAAsC,CAAC;2BAGvC,CAAC;2BAAsC,CAAC;4BACxC,CAAC;;;kBACR,CAAD;;;;;;;;oBAQD,CAAC;2BAAqC,CAAC;sBAElB,CAAC;wBACA,CAAC;oBAAkC,CAAC;oBAG1D,CAAF;sBAAmC,CAAC;uBAE5B,CAAC;uBAAoC,CAAC;uBAChB,CAAC;wBACtB,CAAC;;;;;;oBAOS,CAAC;2BACR,CAAC;sBAAmC,CAAC;wBACtC,CAAC;oBACR,CAAC;oBAAmC,CAAC;sBAE7B,CAAC;uBACa,CAAC;uBAAoC,CAAC;uBAC7C,CAAC;wBACT,CAAC;;;;;;oBAIe,CAAC;2BACd,CAAC;sBAGN,CAAC;wBAER,CAAA;oBACO,CAAC;oBAEG,CAAC;sBACiB,CAAC;uBAC9B,CAAH;uBAGO,CAAJ;uBACQ,CAAC;wBAIX,CADC;;;;;;oBAGmB,CAAA;2BAChB,CAAF;sBAAmC,CAAC;wBACb,CAAC;oBACjB,CAAC;oBAAoC,CAAA;sBAClB,CAAC;uBACjB,CAAC;uBAEY,CAAC;uBAChB,CAAC;wBACP,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAWK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAuI2jB,CAAC;;6BAA4E,CAAC;;;;;;;;;;CADrpB,CAAA"}
+{"version":3,"file":"migration.d.ts","sourceRoot":"","sources":["../../../src/migrations/v-2.1.0/migration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAInE,mCAAmC;AACnC,eAAO,MAAM,eAAe,SAAU,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;;;;;;;;;;oBAG/C,CAAC;mBAIjB,CADJ;qBAA4C,CAAC;;;;0BAKlC,CAAC;mBACR,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiDsD,CAAC;;;;oBASlD,CAAC;;;;;;wBAIF,CAAR;;;;;;sCAM2B,GAAG;oHAMoB,GAAsB;iCAGhE,GAAC;+BACS,GAAG;;+BAKb,CAAC;0BAED,CAAC;4BAIY,CAAA;wBAAoC,CAAC;wBAAqC,CAAC;0BACpF,CAAC;2BAAsC,CAAC;2BAGvC,CAAC;2BAAsC,CAAC;4BACxC,CAAC;;;kBACR,CAAD;;;;;;;;oBAQD,CAAC;2BAAqC,CAAC;sBAElB,CAAC;wBACA,CAAC;oBAAkC,CAAC;oBAG1D,CAAF;sBAAmC,CAAC;uBAE5B,CAAC;uBAAoC,CAAC;uBAChB,CAAC;wBACtB,CAAC;;;;;;oBAOS,CAAC;2BACR,CAAC;sBAAmC,CAAC;wBACtC,CAAC;oBACR,CAAC;oBAAmC,CAAC;sBAE7B,CAAC;uBACa,CAAC;uBAAoC,CAAC;uBAC7C,CAAC;wBACT,CAAC;;;;;;oBAIe,CAAC;2BACd,CAAC;sBACG,CAAC;wBACF,CAAC;oBAIlB,CAAD;oBACG,CAAA;sBACQ,CAAC;uBAGX,CAAF;uBAAoC,CAAC;uBACjC,CAAA;wBAGI,CAAH;;;;;;oBAKyC,CAAC;2BAChC,CAAA;sBACS,CAAC;wBACnB,CAAC;oBAAmC,CAAA;oBACf,CAAC;sBAChB,CAAC;uBAAoC,CAAC;uBACjB,CAAC;uBACjB,CAAC;wBAEU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAWvB,CAAD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAyI4f,CAAC;;6BAA4E,CAAC;;;;;;;;;;CAD9kB,CAAA"}

package/dist/migrations/v-2.1.0/migration.js

@@ -117,6 +117,8 @@ const migrate_v_2_1_0 = (data) => {
             auth,
             'children': c.childUids || [],
             'x-scalar-icon': 'interface-content-folder',
+            'watchForChanges': false,
+            'watchForChangesStatus': 'IDLE',
         };
     });
     // Cookies

package/dist/transforms/export-spec.d.ts

@@ -41,6 +41,8 @@ export declare function exportSpecFromWorkspace({ collection, requests, }: {
         token: string;
         clientSecret: string;
     }>;
+    watchForChanges: boolean;
+    watchForChangesStatus: "IDLE" | "WATCHING" | "ERROR";
     externalDocs?: {
         url: string;
         description?: string | undefined;
@@ -65,5 +67,6 @@ export declare function exportSpecFromWorkspace({ collection, requests, }: {
     } | undefined;
     components?: Record<string, unknown> | undefined;
     webhooks?: Record<string, unknown> | undefined;
+    documentUrl?: string | undefined;
 };
 //# sourceMappingURL=export-spec.d.ts.map

package/dist/transforms/export-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"export-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/export-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAA;AAMxB,wBAAgB,uBAAuB,CAAC,EACtC,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEA"}
+{"version":3,"file":"export-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/export-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EAEb,MAAM,iBAAiB,CAAA;AAMxB,wBAAgB,uBAAuB,CAAC,EACtC,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEA"}

package/dist/transforms/import-spec.d.ts

@@ -1,7 +1,13 @@
-import { type Collection, type Request, type RequestExample, type Server, type Tag } from '../entities/spec/index.js';
+import { type Collection, type CollectionPayload, type Request, type RequestExample, type Server, type Tag } from '../entities/spec/index.js';
 import { type SecurityScheme } from '../entities/spec/security.js';
+import type { OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { AuthenticationState } from '@scalar/types/legacy';
 import type { UnknownObject } from '@scalar/types/utils';
+/** Takes a string or object and parses it into an openapi spec compliant schema */
+export declare const parseSchema: (spec: string | UnknownObject) => Promise<{
+    schema: OpenAPIV3.Document | OpenAPIV3_1.Document;
+    errors: import("@scalar/openapi-parser").ErrorObject[];
+}>;
 /**
  * Import an OpenAPI spec file and convert it to workspace entities
  *
@@ -10,10 +16,11 @@ import type { UnknownObject } from '@scalar/types/utils';
  * created and used at various levels we will index via the uids to create
  * the relationships
  */
-export declare function importSpecToWorkspace(spec: string | UnknownObject, preferredSecurityScheme?: AuthenticationState['preferredSecurityScheme']): Promise<{
+export declare function importSpecToWorkspace(spec: string | UnknownObject, { documentUrl, watchForChanges, preferredSecurityScheme, }?: Pick<CollectionPayload, 'documentUrl' | 'watchForChanges'> & Pick<Partial<AuthenticationState>, 'preferredSecurityScheme'>): Promise<{
     error: false;
     collection: Collection;
     requests: Request[];
+    schema: OpenAPIV3.Document | OpenAPIV3_1.Document;
     examples: RequestExample[];
     servers: Server[];
     tags: Tag[];

package/dist/transforms/import-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAKjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAiCxD;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,uBAAuB,CAAC,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,GACvE,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAkQA"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAIjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAiCxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;YAKjC,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ;;EACrE,CAAA;AAED;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,WAAW,EACX,eAAe,EACf,uBAAuB,GACxB,GAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,iBAAiB,CAAC,GAC3D,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,yBAAyB,CAAM,GACnE,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAiQA"}

package/dist/transforms/import-spec.js

@@ -32,6 +32,13 @@ const convertOauth2Flows = (security, nameKey) => {
         nameKey,
     };
 };
+/** Takes a string or object and parses it into an openapi spec compliant schema */
+const parseSchema = async (spec) => {
+    const { filesystem } = await load(spec);
+    const { specification } = upgrade(filesystem);
+    const { schema, errors = [] } = await dereference(specification);
+    return { schema: schema, errors };
+};
 /**
  * Import an OpenAPI spec file and convert it to workspace entities
  *
@@ -40,11 +47,8 @@ const convertOauth2Flows = (security, nameKey) => {
  * created and used at various levels we will index via the uids to create
  * the relationships
  */
-async function importSpecToWorkspace(spec, preferredSecurityScheme) {
-    const { filesystem } = await load(spec);
-    const { specification } = upgrade(filesystem);
-    const { schema: _schema, errors = [] } = await dereference(specification);
-    const schema = _schema;
+async function importSpecToWorkspace(spec, { documentUrl, watchForChanges, preferredSecurityScheme, } = {}) {
+    const { schema, errors } = await parseSchema(spec);
     const importWarnings = [...errors.map((e) => e.message)];
     if (!schema)
         return { importWarnings, error: true };
@@ -222,6 +226,8 @@ async function importSpecToWorkspace(spec, preferredSecurityScheme) {
     }, {});
     const collection = collectionSchema.parse({
         ...schema,
+        watchForChanges,
+        documentUrl,
         auth,
         requests: requests.map((r) => r.uid),
         servers: servers.map((s) => s.uid),
@@ -241,6 +247,7 @@ async function importSpecToWorkspace(spec, preferredSecurityScheme) {
     return {
         error: false,
         servers,
+        schema,
         requests,
         examples,
         collection,
@@ -249,4 +256,4 @@ async function importSpecToWorkspace(spec, preferredSecurityScheme) {
     };
 }
 
-export { importSpecToWorkspace };
+export { importSpecToWorkspace, parseSchema };

package/dist/transforms/index.js

@@ -1 +1 @@
-export { importSpecToWorkspace } from './import-spec.js';
+export { importSpecToWorkspace, parseSchema } from './import-spec.js';

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.58",
+  "version": "0.2.59",
   "engines": {
     "node": ">=18"
   },
@@ -106,9 +106,9 @@
     "nanoid": "^5.0.7",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
-    "@scalar/object-utils": "1.1.10",
-    "@scalar/themes": "0.9.39",
     "@scalar/openapi-types": "0.1.3",
+    "@scalar/object-utils": "1.1.10",
+    "@scalar/themes": "0.9.40",
     "@scalar/types": "0.0.16"
   },
   "devDependencies": {
@@ -118,8 +118,8 @@
     "vitest": "^1.6.0",
     "zod-to-ts": "^1.2.0",
     "@scalar/build-tooling": "0.1.11",
-    "@scalar/openapi-parser": "0.8.7",
-    "@scalar/openapi-types": "0.1.3"
+    "@scalar/openapi-types": "0.1.3",
+    "@scalar/openapi-parser": "0.8.7"
   },
   "scripts": {
     "build": "scalar-build-rollup",