@starlightcms/js-sdk 4.0.0-beta.2 → 4.0.0-beta.3

package/dist/esm/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAWA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA","sourcesContent":["import { CollectionEntityTypes, SerializedData } from './entities'\nimport { DynamicModelSelector } from '../selectors/Model'\nimport { DynamicModelInstance } from '../instances/Model'\nimport { SingletonSelector } from '../selectors/Singleton'\nimport { DynamicCollectionSelector } from '../selectors/Collection'\nimport { MediaSelector } from '../selectors/Media'\nimport { SearchSelector } from '../selectors/Search'\nimport { CollectionInstance } from '../instances/Collection'\nimport { FormInstance } from '../instances/Form'\nimport { DynamicFormSelector } from '../selectors/Form/types'\n\nexport * from './entities'\nexport * from './fields'\nexport * from './groups'\nexport * from './instances'\nexport * from './selectors'\nexport * from './utilities'\nexport * from './visual'\n\n/**\n * This is a utility type that allows any string to be used as a URL, but\n * provides a default one which can be used by IDEs to provide auto-completion.\n * The default URL points to version 2 of the Query API.\n */\nexport type BaseUrl = 'https://query.starlightcms.io/v2' | string\n\n/**\n * The available options to configure a {@link StarlightClient}.\n *\n * `workspace` is required when creating new clients or configuring the\n * {@apilink default | default client}.\n * @group Client\n */\nexport type StarlightConfig = {\n  /**\n   * The ID of the workspace that the client should use to request data.\n   *\n   * Note: the current APIs only support using workspace IDs as identifiers,\n   * and **not** slugs. Slug support will be added in the future. You can find\n   * the workspace ID in the left-side menu on the Starlight interface or below\n   * the workspace name in the workspace list.\n   */\n  workspace?: string\n  /**\n   * The Starlight Query API URL, including the version, and without a trailing\n   * slash. Defaults to the production Query API URL.\n   *\n   * You only need to set this if you're not using Starlight's production APIs.\n   */\n  baseUrl?: BaseUrl\n  /**\n   * When true, logs all API requests in the console. Defaults to false.\n   */\n  debug?: boolean\n}\n\n/**\n * The Starlight client is the main entry point for any requests you might want\n * to make to Starlight's APIs.\n *\n * There's two ways of interacting with a client: using the\n * {@apilink default | default client} exported by the SDK or creating a new\n * client instance using the\n * {@apilink makeStarlightClient | makeStarlightClient function}. Follow the\n * provided links to learn how to use each method.\n *\n * Either way you choose to interact, all clients expose the same methods and\n * accessors that provide ways to request data. These methods and accessors\n * return Selector or Instance objects, which are documented in the sections\n * of the same name found in this API's sidebar.\n *\n * @group Client\n */\nexport interface StarlightClient<\n  D extends WorkspaceModelDefinition = DefaultModelDefinition,\n> {\n  /**\n   * Updates the client configuration. See {@link StarlightConfig} to see all\n   * the available options.\n   *\n   * If you want to use the {@apilink default | default SDK client}, you need to\n   * set its workspace using this method in your application. You should run\n   * this method only once, and as soon as possible in your application\n   * lifecycle. For instance, when using React:\n   *\n   * ```js\n   * // src/index.js\n   * import { createRoot } from \"react-dom/client\"\n   * import Starlight from '@starlightcms/js-sdk'\n   * import MyApp from './MyApp.js'\n   *\n   * // We only need to run this once. In this case, we're\n   * // running it before initializing our React app.\n   * Starlight.configure({\n   *   workspace: '1234567890'\n   * })\n   *\n   * const rootElement = document.getElementById(\"root\")\n   * const root = createRoot(rootElement)\n   *\n   * root.render(<MyApp />)\n   * ```\n   *\n   * @param config A configuration object. See {@link StarlightConfig} to view\n   * all available options.\n   * @category Other Methods\n   */\n  configure(config: StarlightConfig): void\n\n  /**\n   * Logs a message (or any kind of data, really) into the console if the debug\n   * configuration is true. Uses `console.log` internally.\n   *\n   * This function's type definition is the same as the `console.log` function.\n   *\n   * @param message The data that will be logged.\n   * @param optionalParams Additional data to be logged or string substitutions.\n   * @see [MDN documentation on console.log](https://developer.mozilla.org/en-US/docs/web/api/console/log)\n   * @internal\n   */\n  log(message?: unknown, ...optionalParams: unknown[]): void\n\n  /**\n   * Returns the base API URL for requests, including the configured workspace.\n   * Doesn't include a trailing slash.\n   *\n   * @internal\n   */\n  getBaseUrl(): string\n\n  /**\n   * Returns a Promise that results in a response or throws a StarlightError.\n   * The response will be the parsed JSON data sent by the API.\n   *\n   * This method is used internally by all Selectors and Instances to request\n   * data to Starlight's Query API, but it can also be used standalone if\n   * desired.\n   *\n   * This method automatically prefixes the given path with the API URL, but it\n   * doesn't include a trailing slash, so be sure to include one at the start\n   * of your path.\n   *\n   * @param path The path to GET. Will be prefixed with the API URL. Must start\n   * with a forward slash (/).\n   * @param params An optional object of values that will be converted to a\n   * string and passed as GET params.\n   * @param options An optional configuration object passed to the fetch method.\n   * Check [MDN documentation on fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch)\n   * to see the available options.\n   * @typeParam T - The shape of the expected response on success. Client\n   * methods generally pass {@link StarlightItemResponse} or\n   * {@link StarlightListResponse} types here.\n   * @throws {@link StarlightError} on any errors.\n   * @category Other Methods\n   */\n  get<T = Record<string, unknown>>(\n    path: string,\n    params?: BaseRequestParameters,\n    options?: RequestInit,\n  ): Promise<T>\n\n  /**\n   * Returns a {@link DynamicModelSelector}, which is a {@link ModelSelector}\n   * with support for creating {@apilink ModelInstance | ModelInstances} using the dynamic syntax.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.models.list()\n   * ```\n   *\n   * See {@link DynamicModelSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get models(): DynamicModelSelector<D>\n\n  /**\n   * Returns a {@link DynamicModelInstance}, which is a\n   * {@link ModelInstance} with support for creating\n   * {@apilink ModelCategoryInstance | ModelCategoryInstances} using the dynamic syntax. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.model('posts').entries.list()\n   * ```\n   *\n   * See {@link DynamicModelInstance} for more info.\n   *\n   * @category Instance Methods\n   */\n  model<S extends keyof D>(slug: S): DynamicModelInstance<D[S]>\n\n  /**\n   * Returns a {@link DynamicFormSelector}, which provides support for creating\n   * {@apilink FormInstance | FormInstances} using the dynamic syntax.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.forms.signup.get()\n   * ```\n   *\n   * See {@link DynamicFormSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get forms(): DynamicFormSelector\n\n  /**\n   * Returns a {@link FormInstance}, which provides methods to retrieve basic information\n   * about a Starlight form and its schema. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.form('signup').schema()\n   * ```\n   *\n   * See {@link FormInstance} for more info.\n   *\n   * @category Instance Methods\n   */\n  form(slug: string | number): FormInstance\n\n  /**\n   * Returns a {@link SingletonSelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.singletons.list()\n   * ```\n   *\n   * See {@link SingletonSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get singletons(): SingletonSelector\n\n  /**\n   * Returns a {@link DynamicCollectionSelector}, which is a\n   * {@link CollectionSelector} with support for creating\n   * {@apilink CollectionInstance | CollectionInstances} using the dynamic syntax.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.list()\n   * ```\n   *\n   * See {@link DynamicCollectionSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get collections(): DynamicCollectionSelector\n\n  /**\n   * Returns a {@link CollectionInstance}. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection('featured-posts').items()\n   * ```\n   *\n   * See {@link CollectionInstance} for more info.\n   *\n   * @example Typing the returned CollectionInstance.\n   * ```ts\n   * import Starlight, { MediaObject } from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection<MediaObject>('carousel-images').items()\n   * ```\n   *\n   * @typeParam T - The type of entity this Collection holds. You can pass this\n   * type parameter to correctly type the response of the\n   * {@apilink CollectionInstance.items} method.\n   * @category Instance Methods\n   */\n  collection<T extends CollectionEntityTypes>(\n    slug: string | number,\n  ): CollectionInstance<T>\n\n  /**\n   * Returns a {@link MediaSelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.media.list()\n   * ```\n   *\n   * See {@link MediaSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get media(): MediaSelector\n\n  /**\n   * Returns a {@link SearchSelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.search.entries()\n   * ```\n   *\n   * See {@link SearchSelector} for more info.\n   *\n   * @category Selector Accessors\n   */\n  get search(): SearchSelector\n}\n\n/**\n * This type adds support for the dynamic syntax to the StarlightClient\n * interface, which allows users to create\n * {@apilink DynamicModelInstance| DynamicModelInstances} dynamically.\n * See {@link StarlightClient} to learn which methods it provides. Also see\n * {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n *\n * This allows TypeScript to correctly type all models defined by the user\n * in the DefaultModelDefinition type, aside from letting the user using any\n * \"unknown\" model slug, which is provided by the WorkspaceModelDefinition type.\n *\n * This type is only aware of the DefaultModelDefinition type because the\n * StarlightClient uses it by default when no model definition type is passed.\n *\n * @group Client\n */\nexport type DynamicStarlightClient<T extends WorkspaceModelDefinition> =\n  StarlightClient<T> & {\n    [K in keyof T]: DynamicModelInstance<T[K]>\n  }\n\n/**\n * This interface represents an API response that returns a single entity, like\n * a single {@link Entry} or a single {@link MediaObject}, for instance.\n *\n * It contains only one field: `data`. This field type is generic and\n * depends on the kind of request that was made to the API.\n *\n * All SDK request methods that returna single entity\n * will return this interface.\n *\n * @group Client\n */\nexport interface StarlightItemResponse<T> {\n  /**\n   * The entity returned by the API request. Its type depends on which request\n   * was made. SDK methods will generally type this parameter automatically.\n   */\n  data: T\n}\n\n/**\n * This interface represents an API response that returns a list of entities,\n * like a list of {@apilink Entry | Entries} or a list of items from a\n * {@link Collection}.\n *\n * It contains a `data` parameter, which is an array of items with a generic\n * type that depends on the kind of request that was made, and two metadata\n * objects: `links` and `meta`. Metadata is useful for pagination.\n *\n * All SDK request methods that return a list of entities will return this\n * interface.\n *\n * @group Client\n */\nexport interface StarlightListResponse<T> {\n  /**\n   * The list of entities returned by the API request. Its type depends on which\n   * request was made. SDK methods will generally type\n   * this parameter automatically.\n   */\n  data: T[]\n  /**\n   * An object containing useful links for easier pagination. All links points\n   * to the same list requested, but with a varying `page` parameter.\n   */\n  links: {\n    /**\n     * A link for the first page of the list.\n     */\n    first: string\n    /**\n     * A link for the last page of the list.\n     */\n    last: string\n    /**\n     * A link to the previous page of the list, if there's any.\n     */\n    prev?: string\n    /**\n     * A link to the next page of the list, if there's any.\n     */\n    next?: string\n  }\n  /**\n   * An object with useful metadata related to the current list. It can be used\n   * in applications to create pagination logic and interfaces.\n   *\n   * `from` and `to` are indexes indicating which items start and finish the\n   * current page of the list. For instance, in a list with 100 items with 15\n   * items per page, on the first page, `from` and `to` will be `1` and `15`\n   * respectively.\n   */\n  meta: {\n    /**\n     * The number of the current page.\n     */\n    current_page: number\n    /**\n     * The number of the last page for the current list.\n     */\n    last_page: number\n    /**\n     * The index of the first item on this page out of all list items.\n     */\n    from: number\n    /**\n     * The index of the last item on this page out of all list items.\n     */\n    to: number\n    /**\n     * The number of items per page.\n     */\n    per_page: number\n    /**\n     * The total number of items in the current list.\n     */\n    total: number\n  }\n}\n\n/**\n *  The DefaultModelDefinition type is used to correctly type Entry data when\n *  requesting it using a StarlightClient.\n *\n *  Without using a DefaultModelDefinition, Entry data will be typed as a\n *  \"generic\" JS object which can hold any kind of data:\n *\n *  ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // response type will be StarlightItemResponse<Entry> on request success.\n * const response = await Starlight.posts.entries.get('hello-world')\n *\n * // helloWorld type is Entry<Record<string, unknown>>. This means that\n * // `data` can hold anything, which is not type-safe.\n * const helloWorld = response.data\n * ```\n *\n * One way of safely adding type information to Entry objects is by passing a\n * data definition type to the EntrySelector when requesting something:\n *\n *  ```ts\n * import Starlight, { Group, VisualField, MediaField } from '@starlightcms/js-sdk'\n *\n * type PostFields = {\n *   info: Group<{\n *     featured_image: MediaField\n *     content: VisualField\n *   }>\n * }\n *\n * // response type will now be StarlightItemResponse<Entry<PostsFields>>.\n * const response = await Starlight.posts.entries<PostFields>.get('hello-world')\n *\n * // Now, helloWorld type is Entry<PostsFields>.\n * const helloWorld = response.data\n *\n * // Which means we can safely access its data, and IDEs will\n * // auto-complete the data field name below:\n * console.log(helloWorld.data.info.featured_image)\n * ```\n *\n * Note that we used **Groups** and **Fields** to define our data shape. We\n * recommend using these types, which are exported by this SDK, because they map\n * to the group and field types available in the Starlight admin when creating\n * models, and should simplify the type definition process. All available Group\n * and Field types are documented in the\n * {@apilink BooleanField | Data Fields} and\n * {@apilink Group | Data Groups} sections of this API.\n *\n * However, passing model definition types around your application is not ideal,\n * and actually unnecessary. Using the `DefaultModelDefinition` type, all model\n * definitions can be automatically inferred.\n *\n * To get started, you need to create a\n * [type declaration file](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)\n * in which you'll define all your types. You can name it anything and place it\n * anywhere inside your project, but we recommend naming it `starlight.d.ts` and\n * placing it in the root folder of your source code, so it can be easily\n * imported later in your application if you ever need to reference these types.\n *\n * In this file, you can place all your model type definitions (including type\n * definitions for Singleton data, if you want!). Finally, you just need to\n * add a \"module definition block\" that will tell the SDK which types you expect\n * to receive when requesting models.\n *\n * Here's a complete exemple defining two models, Posts and Magazines:\n *\n * ```ts\n * import {\n *   Group,\n *   RepeaterGroup,\n *   StringField,\n *   VisualField,\n *   MediaField\n * } from '@starlightcms/js-sdk'\n *\n * type PostFields = {\n *   info: Group<{\n *     featured_image: MediaField\n *     content: VisualField\n *   }>\n * }\n *\n * type MagazineFields = {\n *   info: Group<{\n *     cover_image: MediaField\n *     content: VisualField\n *   }>\n *   page_previews: RepeaterGroup<{\n *     image: MediaField\n *     description: StringField\n *   }>\n *   metadata: Group<{\n *     issue_number: StringField\n *     issue_year: StringField\n *   }>\n * }\n *\n * declare module '@starlightcms/js-sdk' {\n *   export interface DefaultModelDefinition {\n *     // Notice how each key in this interface is a Model slug!\n *     posts: PostFields\n *     magazines: MagazineFields\n *   }\n * }\n * ```\n *\n * After creating this file, types should be automatically inferred without the\n * need to pass them around:\n *\n *  ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // response type will be StarlightItemResponse<Entry<PostsFields>>,\n * // which was implicitly inferred by the SDK because of the `posts`\n * // property we added to the `DefaultModelDefinition` above.\n * const response = await Starlight.posts.entries.get('hello-world')\n *\n * // helloWorld type is Entry<PostsFields>\n * const helloWorld = response.data\n *\n * // Auto-complete will work just as before when we explicitly type the Entry!\n * console.log(helloWorld.data.info.featured_image)\n * ```\n *\n *  @group Client\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\n/**\n * This type is only used as a base for the DefaultModelDefinition type.\n *\n * @internal\n */\nexport interface WorkspaceModelDefinition {\n  [slug: string]: SerializedData\n}\n\n/**\n * An object that accepts any string, number and boolean values.\n * Used as the base for most request parameter interfaces in the SDK.\n *\n * @group Request Parameters\n */\nexport interface BaseRequestParameters {\n  [key: string]: string | number | boolean | undefined\n}\n\n/**\n * Request parameters used by most SDK `list()` methods.\n *\n * @group Request Parameters\n */\nexport interface ListRequestParameters extends BaseRequestParameters {\n  /**\n   * The page requested.\n   */\n  page?: number\n  /**\n   * The limit of items per page.\n   */\n  limit?: number\n  /**\n   * A search query string.\n   *\n   * For instance, searching for \"out\" will match both \"check out!\" and\n   * \"about us\". Search is not case-sensitive.\n   */\n  query?: string\n}\n\n/**\n * Request parameters used by most SDK methods that support advanced querying.\n *\n * @group Request Parameters\n */\nexport interface QueryableRequestParameters {\n  /**\n   * A search query string that matches a specific word within boundaries.\n   * Search is not case-sensitive.\n   *\n   * For instance, searching for \"phone\" will match \"This is my phone!\"\n   * but won't match \"This is my telephone!\".\n   */\n  'query:word'?: string\n  /**\n   * A comma-separated list of fields to look up on when searching using\n   * `query` or `query:word`. If undefined, all text fields will be searched on,\n   * including Visual Editor fields. Search is not case-sensitive.\n   *\n   * For instance, to limit search on the \"content\" and \"summary\" fields of a\n   * model, pass `'content,summary'`.\n   */\n  fields?: string\n  /**\n   * If defined, removes the given item from the list. Useful to create \"related\n   * posts\" lists.\n   *\n   * Note: this field only accepts IDs, and not slugs. Only one ID is allowed.\n   */\n  except?: number\n}\n"]}

package/dist/esm/types/instances.d.ts

@@ -1,4 +0,0 @@
-export { CollectionInstance, ListCollectionItemsParams, } from '../instances/Collection';
-export { DynamicModelInstance, ModelInstance } from '../instances/Model';
-export { ModelCategoryInstance, ModelCategoryEntryListParams, } from '../instances/ModelCategory';
-//# sourceMappingURL=instances.d.ts.map

package/dist/esm/types/instances.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"instances.d.ts","sourceRoot":"","sources":["../../../src/types/instances.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,yBAAyB,GAC1B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,EACL,qBAAqB,EACrB,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA"}

package/dist/esm/types/instances.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=instances.js.map

package/dist/esm/types/instances.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instances.js","sourceRoot":"","sources":["../../../src/types/instances.ts"],"names":[],"mappings":"","sourcesContent":["// Instance types are exported here so they are visible in the API docs.\nexport {\n  CollectionInstance,\n  ListCollectionItemsParams,\n} from '../instances/Collection'\nexport { DynamicModelInstance, ModelInstance } from '../instances/Model'\nexport {\n  ModelCategoryInstance,\n  ModelCategoryEntryListParams,\n} from '../instances/ModelCategory'\n"]}

package/dist/esm/types/selectors.d.ts

@@ -1,8 +0,0 @@
-export { ModelCategorySelector, DynamicModelCategorySelector, ListModelCategoriesOptions, } from '../selectors/ModelCategory';
-export { ModelSelector, DynamicModelSelector } from '../selectors/Model';
-export { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams, } from '../selectors/Collection';
-export { EntrySelector, ListEntriesParams } from '../selectors/Entry';
-export { MediaSelector } from '../selectors/Media';
-export { SearchSelector, SearchEntriesParams } from '../selectors/Search';
-export { SingletonSelector } from '../selectors/Singleton';
-//# sourceMappingURL=selectors.d.ts.map

package/dist/esm/types/selectors.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../../src/types/selectors.ts"],"names":[],"mappings":"AACA,OAAO,EACL,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,GAC3B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/esm/types/selectors.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=selectors.js.map

package/dist/esm/types/selectors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../../src/types/selectors.ts"],"names":[],"mappings":"","sourcesContent":["// Selector types are exported here so they are visible in the API docs.\nexport {\n  ModelCategorySelector,\n  DynamicModelCategorySelector,\n  ListModelCategoriesOptions,\n} from '../selectors/ModelCategory'\nexport { ModelSelector, DynamicModelSelector } from '../selectors/Model'\nexport {\n  CollectionSelector,\n  DynamicCollectionSelector,\n  ListCollectionsParams,\n} from '../selectors/Collection'\nexport { EntrySelector, ListEntriesParams } from '../selectors/Entry'\nexport { MediaSelector } from '../selectors/Media'\nexport { SearchSelector, SearchEntriesParams } from '../selectors/Search'\nexport { SingletonSelector } from '../selectors/Singleton'\n"]}

package/dist/esm/types/utilities.d.ts

@@ -1,83 +0,0 @@
-import { RepeaterGroup } from './groups';
-import { Get, Paths } from 'type-fest';
-/**
- * Returns the type of the group or field in the given structure at the
- * specified path. Use dot notation `.` to access items inside groups
- * and bracket notation `[]` to access items inside repeaters.
- *
- * Syntax example:
- *   - foo
- *   - foo.bar
- *   - foo.bar[0].baz
- *   - foo.bar[0].baz.quo
- *
- * This utility is useful to get the type of a deeply nested group or field
- * inside a Model, Singleton or Form structure.
- *
- * @example Retrieving the type of a deeply nested group or field.
- * ```ts
- * import { Group, StringField, GetFromStructure } from '@starlightcms/js-sdk'
- *
- * type ComplexModel = {
- *   info: Group<{
- *     title: StringField
- *     meta: Group<{
- *       keywords: StringField
- *       tags: RepeaterGroup<{
- *         name: StringField
- *       }>
- *     }>
- *   }>
- * }
- *
- * type MetaGroupType = GetFromStructure<ComplexModel, 'info.meta'>
- * // Resulting type -> Group<{ keywords: StringField, tags: RepeaterGroup<{ name: StringField }> }>
- *
- * type KeywordsFieldType = GetFromStructure<ComplexModel, 'info.meta.keywords'>
- * // Resulting type -> StringField
- *
- * type TagNameFieldType = GetFromStructure<ComplexModel, 'info.meta.tags[0].name'>
- * // Resulting type -> StringField
- * ```
- *
- * @group Utility Types
- */
-export type GetFromStructure<Structure, Path extends Paths<Structure, {
-    bracketNotation: true;
-    maxRecursionDepth: 4;
-}>> = Get<Structure, Path>;
-/**
- * Returns the item type of the given Repeater Group.
- *
- * This utility is useful to get the type of the content
- * held in items of a specific Repeater Group.
- *
- * @example Retrieving the type of a repeater item.
- * ```ts
- * import {
- *  RepeaterGroup,
- *  MediaField,
- *  StringField,
- *  GetRepeaterItem,
- *  GetFromStructure
- * } from '@starlightcms/js-sdk'
- *
- * type SlideshowModel = {
- *   slides: RepeaterGroup<{
- *     image: MediaField
- *     description: StringField
- *   }>
- * }
- *
- * type Slide = GetRepeaterItem<SlideshowModel['slides']>
- * // Resulting type -> { image: MediaField, description: StringField }
- *
- * // Also works with the GetFromStructure utility
- * type Slide = GetRepeaterItem<GetFromStructure<SlideshowModel, 'slides'>>
- * // Resulting type -> { image: MediaField, description: StringField }
- * ```
- *
- * @group Utility Types
- */
-export type GetRepeaterItem<Repeater extends RepeaterGroup<Record<string, unknown>>> = Repeater extends readonly (infer ItemType)[] ? ItemType : never;
-//# sourceMappingURL=utilities.d.ts.map

package/dist/esm/types/utilities.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../../../src/types/utilities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,WAAW,CAAA;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,MAAM,gBAAgB,CAC1B,SAAS,EACT,IAAI,SAAS,KAAK,CAChB,SAAS,EACT;IAAE,eAAe,EAAE,IAAI,CAAC;IAAC,iBAAiB,EAAE,CAAC,CAAA;CAAE,CAChD,IACC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,eAAe,CACzB,QAAQ,SAAS,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IACrD,QAAQ,SAAS,SAAS,CAAC,MAAM,QAAQ,CAAC,EAAE,GAAG,QAAQ,GAAG,KAAK,CAAA"}

package/dist/esm/types/utilities.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=utilities.js.map

package/dist/esm/types/utilities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../../src/types/utilities.ts"],"names":[],"mappings":"","sourcesContent":["import { RepeaterGroup } from './groups'\nimport { Get, Paths } from 'type-fest'\n\n/**\n * Returns the type of the group or field in the given structure at the\n * specified path. Use dot notation `.` to access items inside groups\n * and bracket notation `[]` to access items inside repeaters.\n *\n * Syntax example:\n *   - foo\n *   - foo.bar\n *   - foo.bar[0].baz\n *   - foo.bar[0].baz.quo\n *\n * This utility is useful to get the type of a deeply nested group or field\n * inside a Model, Singleton or Form structure.\n *\n * @example Retrieving the type of a deeply nested group or field.\n * ```ts\n * import { Group, StringField, GetFromStructure } from '@starlightcms/js-sdk'\n *\n * type ComplexModel = {\n *   info: Group<{\n *     title: StringField\n *     meta: Group<{\n *       keywords: StringField\n *       tags: RepeaterGroup<{\n *         name: StringField\n *       }>\n *     }>\n *   }>\n * }\n *\n * type MetaGroupType = GetFromStructure<ComplexModel, 'info.meta'>\n * // Resulting type -> Group<{ keywords: StringField, tags: RepeaterGroup<{ name: StringField }> }>\n *\n * type KeywordsFieldType = GetFromStructure<ComplexModel, 'info.meta.keywords'>\n * // Resulting type -> StringField\n *\n * type TagNameFieldType = GetFromStructure<ComplexModel, 'info.meta.tags[0].name'>\n * // Resulting type -> StringField\n * ```\n *\n * @group Utility Types\n */\nexport type GetFromStructure<\n  Structure,\n  Path extends Paths<\n    Structure,\n    { bracketNotation: true; maxRecursionDepth: 4 }\n  >,\n> = Get<Structure, Path>\n\n/**\n * Returns the item type of the given Repeater Group.\n *\n * This utility is useful to get the type of the content\n * held in items of a specific Repeater Group.\n *\n * @example Retrieving the type of a repeater item.\n * ```ts\n * import {\n *  RepeaterGroup,\n *  MediaField,\n *  StringField,\n *  GetRepeaterItem,\n *  GetFromStructure\n * } from '@starlightcms/js-sdk'\n *\n * type SlideshowModel = {\n *   slides: RepeaterGroup<{\n *     image: MediaField\n *     description: StringField\n *   }>\n * }\n *\n * type Slide = GetRepeaterItem<SlideshowModel['slides']>\n * // Resulting type -> { image: MediaField, description: StringField }\n *\n * // Also works with the GetFromStructure utility\n * type Slide = GetRepeaterItem<GetFromStructure<SlideshowModel, 'slides'>>\n * // Resulting type -> { image: MediaField, description: StringField }\n * ```\n *\n * @group Utility Types\n */\nexport type GetRepeaterItem<\n  Repeater extends RepeaterGroup<Record<string, unknown>>,\n> = Repeater extends readonly (infer ItemType)[] ? ItemType : never\n"]}

package/dist/esm/types/visual.d.ts

@@ -1,185 +0,0 @@
-/**
- * All supported block types.
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type BlockType = 'paragraph' | 'quote' | 'header' | 'image' | 'raw' | 'list' | 'video';
-/**
- * Represents the possible block widths, used by some blocks.
- *
- * @group Visual Data Blocks
- * @internal
- */
-type BlockWidth = 'auto' | 'justify' | 'max' | string;
-/**
- * Alignable block type extension
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type AlignableBlock<Base> = Base & {
-    alignment: Alignment;
-};
-/**
- * Represents the possible alignments, used by some blocks.
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type Alignment = 'start' | 'center' | 'end' | 'justify';
-/**
- * Stretchable block type extension
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type StretchableBlock<Base> = Base & {
-    isStretched: boolean;
-};
-/**
- * Base interface for types that represent block data.
- *
- * @group Visual Data Blocks
- */
-export interface BlockData {
-    [key: string]: unknown;
-}
-/**
- * Represents a Paragraph block, which is the default block type used
- * for text content in the Visual Editor.
- *
- * @group Visual Data Blocks
- */
-export type ParagraphBlock = StretchableBlock<AlignableBlock<BaseParagraphBlock>>;
-interface BaseParagraphBlock extends BlockData {
-    text: string | null;
-}
-/**
- * Represents a Header block, which is used to render h1 through h6 HTML elements.
- *
- * @group Visual Data Blocks
- */
-export type HeaderBlock = StretchableBlock<AlignableBlock<BaseHeaderBlock>>;
-interface BaseHeaderBlock extends BlockData {
-    text: string;
-    level: number;
-}
-/**
- * Represents a Quote block, which is used to render a blockquote HTML element.
- *
- * @group Visual Data Blocks
- */
-export interface QuoteBlock extends BlockData {
-    text: string;
-    caption: string;
-    alignment: 'left' | 'center';
-}
-/**
- * Represents an image file, used in Image blocks.
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type ImageFile = {
-    url: string;
-    variation: string;
-    width: number;
-    height: number;
-};
-/**
- * Represents an Image block, which is used to render img or picture HTML elements.
- *
- * @group Visual Data Blocks
- */
-export type ImageBlock = StretchableBlock<AlignableBlock<BaseImageBlock>>;
-interface BaseImageBlock extends BlockData {
-    id: number | undefined;
-    url: string;
-    files: ImageFile[];
-    caption?: string;
-    alt?: string;
-    href?: string;
-    width: BlockWidth;
-    variation: string | undefined;
-    responsive: boolean;
-}
-/**
- * Represents an HTML block, which is used to render custom HTML code. Mainly
- * used to place embeds or heavily customized content structures.
- *
- * @group Visual Data Blocks
- */
-export type HTMLBlock = StretchableBlock<BaseHTMLBlock>;
-interface BaseHTMLBlock extends BlockData {
-    html: string;
-}
-/**
- * Represents a list item, which is used by List blocks.
- *
- * @group Visual Data Blocks
- * @internal
- */
-export interface ListItem {
-    content: string;
-    items?: ListItem[];
-}
-/**
- * Represents a List block, which is used to render ol or ul HTML elements.
- *
- * @group Visual Data Blocks
- */
-export type ListBlock = StretchableBlock<BaseListBlock>;
-interface BaseListBlock extends BlockData {
-    style: 'ordered' | 'unordered';
-    items: ListItem[];
-}
-/**
- * Represents the current supported video services, used in Video blocks.
- *
- * @group Visual Data Blocks
- * @internal
- */
-export type SupportedServices = 'youtube' | 'vimeo';
-/**
- * Represents a Video block, which is used to render embed video elements.
- *
- * @group Visual Data Blocks
- */
-export type VideoBlock = StretchableBlock<AlignableBlock<BaseVideoBlock>>;
-interface BaseVideoBlock extends BlockData {
-    type: 'embed';
-    service: SupportedServices;
-    videoId: string;
-    url: string;
-    html: string;
-    width: BlockWidth;
-    caption?: string;
-    alignment: Alignment;
-}
-/**
- * A VisualDataBlock object represents a piece of content. Each block has a
- * specific type and some data associated with it. For instance, a Paragraph
- * block has text data, an Image block has a file path and image metadata, etc.
- *
- * @group Visual Data Blocks
- */
-export interface VisualDataBlock<D extends BlockData = BlockData> {
-    id: string;
-    type: BlockType;
-    data: D;
-}
-/**
- * VisualData represents content generated by Starlight using a "Visual Editor"
- * field. It's an object-based data representation made out of "blocks". Each
- * block has a type string and some data associated with it.
- *
- * @group Visual Data Blocks
- */
-export interface VisualData {
-    time?: number;
-    version?: string;
-    blocks: VisualDataBlock[];
-}
-export {};
-//# sourceMappingURL=visual.d.ts.map

package/dist/esm/types/visual.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,OAAO,GACP,QAAQ,GACR,OAAO,GACP,KAAK,GACL,MAAM,GACN,OAAO,CAAA;AAEX;;;;;GAKG;AACH,KAAK,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;AAErD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,IAAI,IAAI,GAAG;IACxC,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,CAAA;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,IAAI,IAAI,GAAG;IAC1C,WAAW,EAAE,OAAO,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,CAC3C,cAAc,CAAC,kBAAkB,CAAC,CACnC,CAAA;AAED,UAAU,kBAAmB,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,gBAAgB,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,CAAA;AAE3E,UAAU,eAAgB,SAAQ,SAAS;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAA;AAEzE,UAAU,cAAe,SAAQ,SAAS;IACxC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAA;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,UAAU,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,UAAU,EAAE,OAAO,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAA;AAEvD,UAAU,aAAc,SAAQ,SAAS;IACvC,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAA;AAEvD,UAAU,aAAc,SAAQ,SAAS;IACvC,KAAK,EAAE,SAAS,GAAG,WAAW,CAAA;IAC9B,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,OAAO,CAAA;AAEnD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAA;AAEzE,UAAU,cAAe,SAAQ,SAAS;IACxC,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,EAAE,iBAAiB,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,UAAU,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,SAAS,CAAA;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,SAAS,CAAA;IACf,IAAI,EAAE,CAAC,CAAA;CACR;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B"}

package/dist/esm/types/visual.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=visual.js.map

package/dist/esm/types/visual.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * All supported block types.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type BlockType =\n  | 'paragraph'\n  | 'quote'\n  | 'header'\n  | 'image'\n  | 'raw'\n  | 'list'\n  | 'video'\n\n/**\n * Represents the possible block widths, used by some blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\ntype BlockWidth = 'auto' | 'justify' | 'max' | string\n\n/**\n * Alignable block type extension\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type AlignableBlock<Base> = Base & {\n  alignment: Alignment\n}\n\n/**\n * Represents the possible alignments, used by some blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type Alignment = 'start' | 'center' | 'end' | 'justify'\n\n/**\n * Stretchable block type extension\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type StretchableBlock<Base> = Base & {\n  isStretched: boolean\n}\n\n/**\n * Base interface for types that represent block data.\n *\n * @group Visual Data Blocks\n */\nexport interface BlockData {\n  [key: string]: unknown\n}\n\n/**\n * Represents a Paragraph block, which is the default block type used\n * for text content in the Visual Editor.\n *\n * @group Visual Data Blocks\n */\nexport type ParagraphBlock = StretchableBlock<\n  AlignableBlock<BaseParagraphBlock>\n>\n\ninterface BaseParagraphBlock extends BlockData {\n  text: string | null\n}\n\n/**\n * Represents a Header block, which is used to render h1 through h6 HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport type HeaderBlock = StretchableBlock<AlignableBlock<BaseHeaderBlock>>\n\ninterface BaseHeaderBlock extends BlockData {\n  text: string\n  level: number\n}\n\n/**\n * Represents a Quote block, which is used to render a blockquote HTML element.\n *\n * @group Visual Data Blocks\n */\nexport interface QuoteBlock extends BlockData {\n  text: string\n  caption: string\n  alignment: 'left' | 'center'\n}\n\n/**\n * Represents an image file, used in Image blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type ImageFile = {\n  url: string\n  variation: string\n  width: number\n  height: number\n}\n\n/**\n * Represents an Image block, which is used to render img or picture HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport type ImageBlock = StretchableBlock<AlignableBlock<BaseImageBlock>>\n\ninterface BaseImageBlock extends BlockData {\n  id: number | undefined\n  url: string\n  files: ImageFile[]\n  caption?: string\n  alt?: string\n  href?: string\n  width: BlockWidth\n  variation: string | undefined\n  responsive: boolean\n}\n\n/**\n * Represents an HTML block, which is used to render custom HTML code. Mainly\n * used to place embeds or heavily customized content structures.\n *\n * @group Visual Data Blocks\n */\nexport type HTMLBlock = StretchableBlock<BaseHTMLBlock>\n\ninterface BaseHTMLBlock extends BlockData {\n  html: string\n}\n\n/**\n * Represents a list item, which is used by List blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport interface ListItem {\n  content: string\n  items?: ListItem[]\n}\n\n/**\n * Represents a List block, which is used to render ol or ul HTML elements.\n *\n * @group Visual Data Blocks\n */\nexport type ListBlock = StretchableBlock<BaseListBlock>\n\ninterface BaseListBlock extends BlockData {\n  style: 'ordered' | 'unordered'\n  items: ListItem[]\n}\n\n/**\n * Represents the current supported video services, used in Video blocks.\n *\n * @group Visual Data Blocks\n * @internal\n */\nexport type SupportedServices = 'youtube' | 'vimeo'\n\n/**\n * Represents a Video block, which is used to render embed video elements.\n *\n * @group Visual Data Blocks\n */\nexport type VideoBlock = StretchableBlock<AlignableBlock<BaseVideoBlock>>\n\ninterface BaseVideoBlock extends BlockData {\n  type: 'embed'\n  service: SupportedServices\n  videoId: string\n  url: string\n  html: string\n  width: BlockWidth\n  caption?: string\n  alignment: Alignment\n}\n\n/**\n * A VisualDataBlock object represents a piece of content. Each block has a\n * specific type and some data associated with it. For instance, a Paragraph\n * block has text data, an Image block has a file path and image metadata, etc.\n *\n * @group Visual Data Blocks\n */\nexport interface VisualDataBlock<D extends BlockData = BlockData> {\n  id: string\n  type: BlockType\n  data: D\n}\n\n/**\n * VisualData represents content generated by Starlight using a \"Visual Editor\"\n * field. It's an object-based data representation made out of \"blocks\". Each\n * block has a type string and some data associated with it.\n *\n * @group Visual Data Blocks\n */\nexport interface VisualData {\n  time?: number\n  version?: string\n  blocks: VisualDataBlock[]\n}\n"]}

package/dist/esm/utils/image.d.ts

@@ -1,72 +0,0 @@
-import { MediaFile, MediaObject } from '../types';
-/**
- * Returns the given variation of the provided MediaObject.
- *
- * @param media The MediaObject to analyze. If undefined, the function will also
- * return undefined.
- * @param variation A string or array of strings with the variation name that
- * should be returned. If an array is given, the first variation found will
- * be returned.
- *
- * @returns The MediaFile of the first given variation found. If the provided
- * variations weren't found, or if no variation parameter was provided, returns
- * the optimized variation file (if it exists) or the original file. Returns
- * undefined if no media object is provided.
- *
- * @example Getting the optimized or original file of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaFile } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `info.featured_image` is the path of an arbitrary Media content field.
- * const file = getMediaFile(response.data.data.info.featured_image)
- * ```
- *
- * @category Media Utilities
- */
-export declare const getMediaFile: (media?: MediaObject, variation?: string | string[]) => MediaFile | undefined;
-/**
- * Returns the source URL of the optimized file (if it exists) or the original
- * file of the given MediaObject. If the variation parameter is provided,
- * returns the source URL of that variation instead, if it exists, but falls
- * back to the optimized or original files if it doesn't.
- *
- * @param media The MediaObject to analyze. If undefined, the function will also
- * return undefined.
- * @param variation A string or array of strings with the variation name that
- * should be returned. If an array is given, the first variation found will
- * be returned.
- *
- * @returns The source URL of the first given variation found. If the provided
- * variations weren't found, or if no variation parameter was provided, returns
- * the optimized variation source URL (if it exists) or the original source URL.
- * Returns undefined if no media object is provided.
- *
- * @example Getting the optimized or original source URL of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `content.background` is the path of an arbitrary Media content field.
- * const imageUrl = getMediaSource(response.data.data.content.background)
- * ```
- *
- * @example Getting the source URL of a specific variation of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `content.background` is the path of an arbitrary Media content field.
- * const imageUrl = getMediaSource(
- *   response.data.data.content.background,
- *   ['large', 'medium']
- * )
- * ```
- *
- * @category Media Utilities
- */
-export declare function getMediaSource(media?: MediaObject, variation?: string | string[]): string | undefined;
-//# sourceMappingURL=image.d.ts.map

package/dist/esm/utils/image.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/utils/image.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAejD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,GACvB,QAAQ,WAAW,EACnB,YAAY,MAAM,GAAG,MAAM,EAAE,KAC5B,SAAS,GAAG,SAgBd,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,cAAc,CAC5B,KAAK,CAAC,EAAE,WAAW,EACnB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,sBAG9B"}

package/dist/esm/utils/image.js

@@ -1,96 +0,0 @@
-/**
- * Returns the optimized variation file of the given MediaObject
- * or the original file if the optimized variation doesn't exist.
- *
- * @param media The MediaObject to analyze.
- */
-const getOptimizedOrOriginal = (media) => {
-    var _a;
-    return ((_a = media.files.find((file) => file.variation === 'optimized')) !== null && _a !== void 0 ? _a : media.files.find((file) => file.variation === 'original'));
-};
-/**
- * Returns the given variation of the provided MediaObject.
- *
- * @param media The MediaObject to analyze. If undefined, the function will also
- * return undefined.
- * @param variation A string or array of strings with the variation name that
- * should be returned. If an array is given, the first variation found will
- * be returned.
- *
- * @returns The MediaFile of the first given variation found. If the provided
- * variations weren't found, or if no variation parameter was provided, returns
- * the optimized variation file (if it exists) or the original file. Returns
- * undefined if no media object is provided.
- *
- * @example Getting the optimized or original file of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaFile } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `info.featured_image` is the path of an arbitrary Media content field.
- * const file = getMediaFile(response.data.data.info.featured_image)
- * ```
- *
- * @category Media Utilities
- */
-export const getMediaFile = (media, variation) => {
-    if (!media)
-        return undefined;
-    if (variation) {
-        const variationArray = Array.isArray(variation) ? variation : [variation];
-        for (const variationName of variationArray) {
-            const file = media.files.find((file) => file.variation === variationName);
-            if (file) {
-                return file;
-            }
-        }
-    }
-    return getOptimizedOrOriginal(media);
-};
-/**
- * Returns the source URL of the optimized file (if it exists) or the original
- * file of the given MediaObject. If the variation parameter is provided,
- * returns the source URL of that variation instead, if it exists, but falls
- * back to the optimized or original files if it doesn't.
- *
- * @param media The MediaObject to analyze. If undefined, the function will also
- * return undefined.
- * @param variation A string or array of strings with the variation name that
- * should be returned. If an array is given, the first variation found will
- * be returned.
- *
- * @returns The source URL of the first given variation found. If the provided
- * variations weren't found, or if no variation parameter was provided, returns
- * the optimized variation source URL (if it exists) or the original source URL.
- * Returns undefined if no media object is provided.
- *
- * @example Getting the optimized or original source URL of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `content.background` is the path of an arbitrary Media content field.
- * const imageUrl = getMediaSource(response.data.data.content.background)
- * ```
- *
- * @example Getting the source URL of a specific variation of the given MediaObject.
- * ```ts
- * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.get('foo')
- *
- * // `content.background` is the path of an arbitrary Media content field.
- * const imageUrl = getMediaSource(
- *   response.data.data.content.background,
- *   ['large', 'medium']
- * )
- * ```
- *
- * @category Media Utilities
- */
-export function getMediaSource(media, variation) {
-    return media ? getMediaFile(media, variation).path : undefined;
-}
-//# sourceMappingURL=image.js.map

package/dist/esm/utils/image.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../src/utils/image.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,CAAC,KAAkB,EAAE,EAAE;;IACpD,OAAO,CACL,MAAA,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,WAAW,CAAC,mCACzD,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,UAAU,CAAe,CACzE,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,KAAmB,EACnB,SAA6B,EACN,EAAE;IACzB,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;QAEzE,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,aAAa,CAAC,CAAA;YAEzE,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAA;AACtC,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAmB,EACnB,SAA6B;IAE7B,OAAO,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;AACjE,CAAC","sourcesContent":["import { MediaFile, MediaObject } from '../types'\n\n/**\n * Returns the optimized variation file of the given MediaObject\n * or the original file if the optimized variation doesn't exist.\n *\n * @param media The MediaObject to analyze.\n */\nconst getOptimizedOrOriginal = (media: MediaObject) => {\n  return (\n    media.files.find((file) => file.variation === 'optimized') ??\n    (media.files.find((file) => file.variation === 'original') as MediaFile)\n  )\n}\n\n/**\n * Returns the given variation of the provided MediaObject.\n *\n * @param media The MediaObject to analyze. If undefined, the function will also\n * return undefined.\n * @param variation A string or array of strings with the variation name that\n * should be returned. If an array is given, the first variation found will\n * be returned.\n *\n * @returns The MediaFile of the first given variation found. If the provided\n * variations weren't found, or if no variation parameter was provided, returns\n * the optimized variation file (if it exists) or the original file. Returns\n * undefined if no media object is provided.\n *\n * @example Getting the optimized or original file of the given MediaObject.\n * ```ts\n * import Starlight, { getMediaFile } from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('foo')\n *\n * // `info.featured_image` is the path of an arbitrary Media content field.\n * const file = getMediaFile(response.data.data.info.featured_image)\n * ```\n *\n * @category Media Utilities\n */\nexport const getMediaFile = (\n  media?: MediaObject,\n  variation?: string | string[],\n): MediaFile | undefined => {\n  if (!media) return undefined\n\n  if (variation) {\n    const variationArray = Array.isArray(variation) ? variation : [variation]\n\n    for (const variationName of variationArray) {\n      const file = media.files.find((file) => file.variation === variationName)\n\n      if (file) {\n        return file\n      }\n    }\n  }\n\n  return getOptimizedOrOriginal(media)\n}\n\n/**\n * Returns the source URL of the optimized file (if it exists) or the original\n * file of the given MediaObject. If the variation parameter is provided,\n * returns the source URL of that variation instead, if it exists, but falls\n * back to the optimized or original files if it doesn't.\n *\n * @param media The MediaObject to analyze. If undefined, the function will also\n * return undefined.\n * @param variation A string or array of strings with the variation name that\n * should be returned. If an array is given, the first variation found will\n * be returned.\n *\n * @returns The source URL of the first given variation found. If the provided\n * variations weren't found, or if no variation parameter was provided, returns\n * the optimized variation source URL (if it exists) or the original source URL.\n * Returns undefined if no media object is provided.\n *\n * @example Getting the optimized or original source URL of the given MediaObject.\n * ```ts\n * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('foo')\n *\n * // `content.background` is the path of an arbitrary Media content field.\n * const imageUrl = getMediaSource(response.data.data.content.background)\n * ```\n *\n * @example Getting the source URL of a specific variation of the given MediaObject.\n * ```ts\n * import Starlight, { getMediaSource } from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.get('foo')\n *\n * // `content.background` is the path of an arbitrary Media content field.\n * const imageUrl = getMediaSource(\n *   response.data.data.content.background,\n *   ['large', 'medium']\n * )\n * ```\n *\n * @category Media Utilities\n */\nexport function getMediaSource(\n  media?: MediaObject,\n  variation?: string | string[],\n) {\n  return media ? getMediaFile(media, variation)!.path : undefined\n}\n"]}

package/dist/esm/utils/index.d.ts

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

package/dist/esm/utils/index.d.ts.map

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

package/dist/esm/utils/index.js

@@ -1,2 +0,0 @@
-export * from './image';
-//# sourceMappingURL=index.js.map

package/dist/esm/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA","sourcesContent":["export * from './image'\n"]}