@scalar/oas-utils 0.2.72 → 0.2.74

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scalar/oas-utils
 
+## 0.2.74
+
+### Patch Changes
+
+- ac55d0f: chore: add time logging for the workspace store
+- Updated dependencies [0c07766]
+  - @scalar/themes@0.9.48
+
+## 0.2.73
+
+### Patch Changes
+
+- 82f7c35: fix: rollback proxy
+- 3421489: fix: remove examples from request payload before parsing
+
 ## 0.2.72
 
 ### Patch Changes

package/dist/helpers/makeUrlAbsolute.d.ts

@@ -1,5 +1,5 @@
 /**
  * Pass an URL or a relative URL and get an absolute URL
  */
-export declare const makeUrlAbsolute: (url?: string, baseUrl?: string) => string | undefined;
+export declare const makeUrlAbsolute: (url?: string) => string | undefined;
 //# sourceMappingURL=makeUrlAbsolute.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"makeUrlAbsolute.d.ts","sourceRoot":"","sources":["../../src/helpers/makeUrlAbsolute.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe,SAAU,MAAM,YAAY,MAAM,uBAsB7D,CAAA"}
+{"version":3,"file":"makeUrlAbsolute.d.ts","sourceRoot":"","sources":["../../src/helpers/makeUrlAbsolute.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,eAAe,SAAU,MAAM,uBAqB3C,CAAA"}

package/dist/helpers/makeUrlAbsolute.js

@@ -1,16 +1,15 @@
 /**
  * Pass an URL or a relative URL and get an absolute URL
  */
-const makeUrlAbsolute = (url, baseUrl) => {
+const makeUrlAbsolute = (url) => {
     if (!url ||
         url.startsWith('http://') ||
         url.startsWith('https://') ||
-        (typeof window === 'undefined' && !baseUrl)) {
+        typeof window === 'undefined')
         return url;
-    }
-    const base = baseUrl || window.location.href;
+    const baseUrl = window.location.href;
     // Remove any query parameters or hash from the base URL
-    const cleanBaseUrl = base.split('?')[0]?.split('#')[0];
+    const cleanBaseUrl = baseUrl.split('?')[0]?.split('#')[0];
     // For base URLs with a path component, we want to remove the last path segment
     // if it doesn't end with a slash
     const normalizedBaseUrl = cleanBaseUrl?.endsWith('/')

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

@@ -15,12 +15,17 @@ export type ImportSpecToWorkspaceArgs = Pick<CollectionPayload, 'documentUrl' |
     setCollectionSecurity?: boolean;
 };
 /**
- * Import an OpenAPI spec file and convert it to workspace entities
+ * Imports an OpenAPI document and converts it to workspace entities (Collection, Request, Server, etc.)
  *
- * We will aim to keep the entities as close to the specification as possible
- * to leverage bi-directional translation. Where entities are able to be
- * created and used at various levels we will index via the uids to create
- * the relationships
+ * The imported entities maintain a close mapping to the original OpenAPI specification to enable:
+ * - Bi-directional translation between spec and workspace entities
+ * - Preservation of specification details and structure
+ * - Accurate representation of relationships between components
+ *
+ * Relationships between entities are maintained through unique identifiers (UIDs) which allow:
+ * - Flexible organization at different levels (workspace, collection, request)
+ * - Proper linking between related components
+ * - Easy lookup and reference of dependent entities
  */
 export declare function importSpecToWorkspace(spec: string | UnknownObject, { authentication, baseServerURL, documentUrl, servers: overloadServers, setCollectionSecurity, watchMode, }?: ImportSpecToWorkspaceArgs): Promise<{
     error: false;

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,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,0BAA0B,EAIhC,MAAM,0BAA0B,CAAA;AAIjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAwDxD,2DAA2D;AAC3D,eAAO,MAAM,iBAAiB,WACpB,cAAc,SACf,sBAAsB,CAAC,gBAAgB,CAAC,KAC9C,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAgC5D,CAAA;AAED,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;YAKjC,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ;;EACrE,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,SAAiB,GAClB,GAAE,yBAA8B,GAChC,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,CAkSA"}
+{"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,EACnB,KAAK,0BAA0B,EAIhC,MAAM,0BAA0B,CAAA;AAIjC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAwDxD,2DAA2D;AAC3D,eAAO,MAAM,iBAAiB,WACpB,cAAc,SACf,sBAAsB,CAAC,gBAAgB,CAAC,KAC9C,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,0BAA0B,CAgC5D,CAAA;AAED,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAAgB,MAAM,GAAG,aAAa;YAOjC,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ;;EACrE,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,eAAe,EACxB,qBAA6B,EAC7B,SAAiB,GAClB,GAAE,yBAA8B,GAChC,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,CA8SA"}

package/dist/transforms/import-spec.js

@@ -86,18 +86,25 @@ const getBaseAuthValues = (scheme, auth) => {
 };
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec) => {
+    // TODO: Plugins for URLs and files with the proxy is missing here.
+    // @see packages/api-reference/src/helpers/parse.ts
     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
+ * Imports an OpenAPI document and converts it to workspace entities (Collection, Request, Server, etc.)
  *
- * We will aim to keep the entities as close to the specification as possible
- * to leverage bi-directional translation. Where entities are able to be
- * created and used at various levels we will index via the uids to create
- * the relationships
+ * The imported entities maintain a close mapping to the original OpenAPI specification to enable:
+ * - Bi-directional translation between spec and workspace entities
+ * - Preservation of specification details and structure
+ * - Accurate representation of relationships between components
+ *
+ * Relationships between entities are maintained through unique identifiers (UIDs) which allow:
+ * - Flexible organization at different levels (workspace, collection, request)
+ * - Proper linking between related components
+ * - Easy lookup and reference of dependent entities
  */
 async function importSpecToWorkspace(spec, { authentication, baseServerURL, documentUrl, servers: overloadServers, setCollectionSecurity = false, watchMode = false, } = {}) {
     const { schema, errors } = await parseSchema(spec);
@@ -106,6 +113,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
         return { importWarnings, error: true };
     // ---------------------------------------------------------------------------
     // Some entities will be broken out as individual lists for modification in the workspace
+    const start = performance.now();
     const requests = [];
     // Grab the base server URL for relative servers
     const backupBaseServerUrl = typeof window !== 'undefined' ? window.location.origin : 'http://localhost';
@@ -213,6 +221,11 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
                     ],
                     servers: [...pathServers, ...operationServers].map((s) => s.uid),
                 };
+                // Remove any examples from the request payload as they conflict with our examples property and are not valid
+                if (requestPayload.examples) {
+                    console.warn('[@scalar/api-client] operation.examples is not a valid openapi property');
+                    delete requestPayload.examples;
+                }
                 // Add list of UIDs to associate security schemes
                 // As per the spec if there is operation level security we ignore the top level requirements
                 if (operationSecurity?.length)
@@ -319,6 +332,8 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
         },
         securitySchemes: securitySchemes.map((s) => s.uid),
     });
+    const end = performance.now();
+    console.log(`workspace: ${Math.round(end - start)} ms`);
     /**
      * Servers and requests will be saved in top level maps and indexed via UID to
      * maintain specification relationships

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.72",
+  "version": "0.2.74",
   "engines": {
     "node": ">=18"
   },
@@ -107,17 +107,17 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.47",
-    "@scalar/types": "0.0.19",
-    "@scalar/openapi-types": "0.1.5"
+    "@scalar/openapi-types": "0.1.5",
+    "@scalar/themes": "0.9.48",
+    "@scalar/types": "0.0.19"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
     "vite": "^5.4.9",
     "vitest": "^1.6.0",
     "zod-to-ts": "^1.2.0",
-    "@scalar/build-tooling": "0.1.12",
     "@scalar/openapi-parser": "0.8.9",
+    "@scalar/build-tooling": "0.1.12",
     "@scalar/openapi-types": "0.1.5"
   },
   "scripts": {