@starlightcms/js-sdk 0.9.0 → 0.11.0

package/dist/cjs/types/index.d.ts

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

package/dist/cjs/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AAExB,aAAK,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAEvD,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,wBAAwB,GAAG,sBAAsB;IAE3D,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D,UAAU,IAAI,MAAM,CAAA;IAEpB,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,EAC9D,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb,IAAI,MAAM,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAA;IAErC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE7D,IAAI,UAAU,IAAI,iBAAiB,CAAA;IAEnC,IAAI,WAAW,IAAI,yBAAyB,CAAA;IAE5C,UAAU,CAAC,CAAC,SAAS,eAAe,GAAG,MAAM,EAC3C,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,kBAAkB,CAAC,CAAC,CAAC,CAAA;IAExB,IAAI,KAAK,IAAI,aAAa,CAAA;IAE1B,IAAI,MAAM,IAAI,cAAc,CAAA;CAC7B;AAED,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,CAAC,CAAC,CAAC,GAAG;KAClB,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAA;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAGD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAC/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAE3B;;;;GAIG;AACH,oBAAY,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAE9D;;;;;;GAMG;AACH,oBAAY,eAAe,GAAG;IAC5B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe,CAC9B,CAAC,SAAS,wBAAwB,GAAG,sBAAsB;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D;;;;;OAKG;IACH,UAAU,IAAI,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,EAC9D,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,MAAM,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAA;IAErC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE7D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,UAAU,IAAI,iBAAiB,CAAA;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,WAAW,IAAI,yBAAyB,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,UAAU,CAAC,CAAC,SAAS,qBAAqB,EACxC,IAAI,EAAE,MAAM,GAAG,MAAM,GACpB,kBAAkB,CAAC,CAAC,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,KAAK,IAAI,aAAa,CAAA;IAE1B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,MAAM,IAAI,cAAc,CAAA;CAC7B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,CAAC,CAAC,CAAC,GAAG;KAClB,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA;AAEH;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAA;CACR;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC;;;;OAIG;IACH,IAAI,EAAE,CAAC,EAAE,CAAA;IACT;;;OAGG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;;;;;;OAQG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QACpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;QACjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AAEH,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB"}

package/dist/cjs/types/index.js

@@ -17,4 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./fields"), exports);
 __exportStar(require("./entities"), exports);
 __exportStar(require("./visual"), exports);
+__exportStar(require("./instances"), exports);
+__exportStar(require("./selectors"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AASA,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB","sourcesContent":["import { CollectionTypes, SerializedData } from './entities'\nimport { ProxiedModelSelector } from '../selectors/Model'\nimport { ProxiedModelInstance } from '../instances/Model'\nimport { SingletonSelector } from '../selectors/Singleton'\nimport { ProxiedCollectionSelector } from '../selectors/Collection'\nimport { MediaSelector } from '../selectors/Media'\nimport { SearchSelector } from '../selectors/Search'\nimport { CollectionInstance } from '../instances/Collection'\n\nexport * from './fields'\nexport * from './entities'\nexport * from './visual'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n  workspace?: string\n  baseUrl?: BaseUrl\n  debug?: boolean\n}\n\nexport interface StarlightClient<\n  D extends WorkspaceModelDefinition = DefaultModelDefinition\n> {\n  configure(config: StarlightConfig): void\n\n  log(message?: unknown, ...optionalParams: unknown[]): void\n\n  getBaseUrl(): string\n\n  get<T = Record<string, unknown>>(\n    path: string,\n    params?: Record<string, string | number | boolean | undefined>,\n    options?: RequestInit\n  ): Promise<T>\n\n  get models(): ProxiedModelSelector<D>\n\n  model<S extends keyof D>(slug: S): ProxiedModelInstance<D[S]>\n\n  get singletons(): SingletonSelector\n\n  get collections(): ProxiedCollectionSelector\n\n  collection<T extends CollectionTypes = string>(\n    slug: string | number\n  ): CollectionInstance<T>\n\n  get media(): MediaSelector\n\n  get search(): SearchSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n  StarlightClient<T> & {\n    [K in keyof T]: ProxiedModelInstance<T[K]>\n  }\n\nexport interface StarlightItemResponse<T> {\n  data: T\n}\n\nexport interface StarlightListResponse<T> {\n  data: T[]\n  links: {\n    first: string\n    last: string\n    prev?: string\n    next?: string\n  }\n  meta: {\n    current_page: number\n    last_page: number\n    from: number\n    to: number\n    per_page: number\n    total: number\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\nexport interface WorkspaceModelDefinition {\n  [slug: string]: SerializedData\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AASA,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB;AACxB,8CAA2B;AAC3B,8CAA2B","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'\n\nexport * from './fields'\nexport * from './entities'\nexport * from './visual'\nexport * from './instances'\nexport * from './selectors'\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.starlight.sh/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?: Record<string, string | number | boolean | undefined>,\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 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, { VisualField, MediaField } from '@starlightcms/js-sdk'\n *\n * type PostFields = {\n *   featured_image: MediaField\n *   content: VisualField\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.featured_image)\n * ```\n *\n * Note that we used \"Fields\" to define our data shape. We recommend using these\n * types, which are exported by this SDK, because they map to the field types\n * available in the Starlight admin when creating models, and should simplify\n * the type definition process. All available Field types are documented in the\n * {@apilink BooleanField | Data Fields section 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 { StringField, VisualField, MediaField } from '@starlightcms/js-sdk'\n *\n * type PostFields = {\n *   featured_image: MediaField\n *   content: VisualField\n * }\n *\n * type MagazineFields = {\n *   cover_image: MediaField\n *   content: VisualField\n *   issue_number: StringField\n *   issue_year: StringField\n * }\n *\n * declare module '@starlightcms/js-sdk' {\n *   export interface DefaultModelDefinition {\n *     // Notice that 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 these types 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!\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.featured_image)\n * ```\n *\n *  @group Client\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\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 * Request parameters used by most SDK `list()` methods.\n *\n * @group Request Parameters\n */\nexport interface 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/cjs/types/instances.d.ts

@@ -0,0 +1,4 @@
+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/cjs/types/instances.d.ts.map

@@ -0,0 +1 @@
+{"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/cjs/types/instances.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=instances.js.map

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

@@ -0,0 +1 @@
+{"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"]}