@scalar/types 0.1.8 → 0.1.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/types
 
+## 0.1.9
+
+### Patch Changes
+
+- 17e7d02: chore: export more types from the base types package for commonjs apps
+
 ## 0.1.8
 
 ### Patch Changes

package/dist/api-reference/html-api.d.ts

@@ -0,0 +1,30 @@
+import type { AnyApiReferenceConfiguration } from '../api-reference/api-reference-configuration.ts';
+/**
+ * This is a subset of the vue app type
+ * Didn't want to add vue as a dependency just for this type so we stub whatever we need for the html api
+ */
+type App<HostElement = any> = {
+    mount(rootContainer: HostElement | string): unknown;
+    unmount(): void;
+    onUnmount(cb: () => void): void;
+};
+/** Enhanced ApiReferenceInstance with subset vue app */
+export type ApiReferenceInstance = {
+    /** The vue app instance */
+    app: App<Element>;
+    /** Destroy the current API Reference instance */
+    destroy: () => void;
+    /** Get the current configuration[s] */
+    getConfiguration: () => AnyApiReferenceConfiguration;
+    /** Update all configuration[s] */
+    updateConfiguration: (newConfig: AnyApiReferenceConfiguration) => void;
+};
+/** Function overload for createApiReference to allow multiple different signatures */
+export type CreateApiReference = {
+    /** Pass in the configuration only */
+    (configuration: AnyApiReferenceConfiguration): ApiReferenceInstance;
+    /** Pass in the element or selector and configuration */
+    (elementOrSelector: Element | string, configuration: AnyApiReferenceConfiguration): ApiReferenceInstance;
+};
+export {};
+//# sourceMappingURL=html-api.d.ts.map

package/dist/api-reference/html-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../src/api-reference/html-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAA;AAElG;;;GAGG;AACH,KAAK,GAAG,CAAC,WAAW,GAAG,GAAG,IAAI;IAC5B,KAAK,CAAC,aAAa,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,CAAA;IACnD,OAAO,IAAI,IAAI,CAAA;IACf,SAAS,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAChC,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,oBAAoB,GAAG;IACjC,2BAA2B;IAC3B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACjB,iDAAiD;IACjD,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,uCAAuC;IACvC,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;IACpD,kCAAkC;IAClC,mBAAmB,EAAE,CAAC,SAAS,EAAE,4BAA4B,KAAK,IAAI,CAAA;CACvE,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qCAAqC;IACrC,CAAC,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;IACnE,wDAAwD;IACxD,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,EAAE,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;CACzG,CAAA"}

package/dist/api-reference/index.d.ts

@@ -2,4 +2,5 @@ export { type ApiClientConfiguration, type ApiReferenceConfiguration, type ApiRe
 export { type HtmlRenderingConfiguration, htmlRenderingConfigurationSchema, } from './html-rendering-configuration.ts';
 export { migrateThemeVariables } from './helpers/migrate-theme-variables.ts';
 export type { SpecificationExtension, ApiReferencePlugin, } from './api-reference-plugin.ts';
+export type { ApiReferenceInstance, CreateApiReference } from './html-api.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/api-reference/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,4BAA4B,EAC5B,+BAA+B,EAC/B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA;AAE5E,YAAY,EACV,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,2BAA2B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,4BAA4B,EAC5B,+BAA+B,EAC/B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA;AAE5E,YAAY,EACV,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,2BAA2B,CAAA;AAElC,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA"}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+/** We should not use these exports anymore, but we need them for commonjs compatibility. */
 export * from './legacy/index.ts';
+export * from './api-reference/index.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA"}

package/dist/index.js

@@ -1 +1,4 @@
 export { XScalarStability } from './legacy/reference-config.js';
+export { apiClientConfigurationSchema, apiReferenceConfigurationSchema, isConfigurationWithSources, specConfigurationSchema } from './api-reference/api-reference-configuration.js';
+export { htmlRenderingConfigurationSchema } from './api-reference/html-rendering-configuration.js';
+export { migrateThemeVariables } from './api-reference/helpers/migrate-theme-variables.js';

package/package.json

@@ -16,7 +16,7 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.8",
+  "version": "0.1.9",
   "engines": {
     "node": ">=18"
   },