@nohead/sdk 0.3.0 → 0.5.0

package/dist/resources/assets.d.ts

@@ -38,7 +38,7 @@ export declare class Assets extends Resource {
     createUpload(params: AssetUploadCreate, options?: RequestOptions): APIPromise<AssetWithUpload>;
     /** Checks an uploaded file and marks the asset `ready`. */
     complete(asset: string, options?: RequestOptions): APIPromise<Asset>;
-    list(params?: AssetListParams, options?: RequestOptions): PagePromise<Asset>;
+    list({ content_type, ...params }?: AssetListParams, options?: RequestOptions): PagePromise<Asset>;
     get(asset: string, options?: RequestOptions): APIPromise<Asset>;
     /**
      * Soft-deletes the asset: `restore` brings it back until its

package/dist/resources/assets.js

@@ -74,8 +74,15 @@ export class Assets extends Resource {
     complete(asset, options) {
         return this.core.request("assets_complete", { path: { asset_id: asset } }, options);
     }
-    list(params = {}, options) {
-        return this.core.paginate("assets_list", { query: listQuery(params, ["deleted", "content_type"]) }, options);
+    list({ content_type, ...params } = {}, options) {
+        return this.core.paginate("assets_list", {
+            query: listQuery({
+                ...params,
+                content_type: Array.isArray(content_type)
+                    ? { in: content_type }
+                    : content_type,
+            }, ["deleted", "content_type"]),
+        }, options);
     }
     get(asset, options) {
         return this.core.request("assets_get", { path: { asset_id: asset } }, options);

package/dist/resources/drafts.d.ts

@@ -19,11 +19,10 @@ export declare class Drafts extends Resource {
      */
     create<D = RecordData>(record: string, params?: DraftCreateParams<D>, options?: RequestOptions): APIPromise<NoheadDraft<D>>;
     /**
-     * A collection's drafts, most recently changed first. `record_id` narrows
-     * them to one record, or to several (1 to 100; an empty list is a
-     * `TypeError`, since it would match no record).
+     * A collection's drafts, most recently changed first. One record's draft
+     * is `records.drafts(record)`.
      */
-    list<D = RecordData>(collection: string, { record_id, ...params }?: DraftListParams, options?: RequestOptions): PagePromise<NoheadDraft<D>>;
+    list<D = RecordData>(collection: string, params?: DraftListParams, options?: RequestOptions): PagePromise<NoheadDraft<D>>;
     /** With `data` as the record reads after the merge, for previews. */
     get<D = RecordData>(draft: string, params?: DraftGetParams, options?: RequestOptions): APIPromise<NoheadDraft<D>>;
     /** Sets the given fields (`null` clears one), as a record update does. */

package/dist/resources/drafts.js

@@ -17,22 +17,11 @@ export class Drafts extends Resource {
         return this.core.request("drafts_create", { path: { record_id: record }, body: params }, options);
     }
     /**
-     * A collection's drafts, most recently changed first. `record_id` narrows
-     * them to one record, or to several (1 to 100; an empty list is a
-     * `TypeError`, since it would match no record).
+     * A collection's drafts, most recently changed first. One record's draft
+     * is `records.drafts(record)`.
      */
-    list(collection, { record_id, ...params } = {}, options) {
-        if (Array.isArray(record_id) && record_id.length === 0)
-            throw new TypeError("record_id needs at least one record ID");
-        const filter = record_id === undefined
-            ? undefined
-            : {
-                record_id: Array.isArray(record_id) ? { in: record_id } : record_id,
-            };
-        return this.core.paginate("drafts_list", {
-            path: { collection_id: collection },
-            query: { ...params, ...(filter && { filter }) },
-        }, options);
+    list(collection, params = {}, options) {
+        return this.core.paginate("drafts_list", { path: { collection_id: collection }, query: params }, options);
     }
     /** With `data` as the record reads after the merge, for previews. */
     get(draft, params = {}, options) {

package/dist/resources/schema.d.ts

@@ -1,7 +1,7 @@
 import type { APIPromise, PagePromise } from "../api-promise.ts";
 import type { RequestOptions, WriteOptions } from "../core.ts";
 import type { Collection, FieldOrder, CollectionCreate, CollectionUpdate, Field, FieldCreate, FieldMigration, FieldMigrationPreview, FieldUpdate, Schema, SchemaChange, SchemaChangeDetail, SearchIndex } from "../generated/types.gen.ts";
-import type { DeletedListParams, DryRunParams, FieldMigrateParams, FieldReorderParams, ListParams, SchemaParams } from "../types.ts";
+import type { DeletedListParams, DryRunParams, FieldReorderParams, ListParams, MigrationCreateParams, SchemaParams } from "../types.ts";
 import { Resource } from "./resource.ts";
 /** Collections of the key's project. `collection` is an ID or slug. */
 export declare class Collections extends Resource {
@@ -24,7 +24,7 @@ export declare class Collections extends Resource {
 /** A collection's schema history, newest first. */
 export declare class SchemaChanges extends Resource {
     list(collection: string, params?: ListParams, options?: RequestOptions): PagePromise<SchemaChange>;
-    get(collection: string, schemaChange: string, options?: RequestOptions): APIPromise<SchemaChangeDetail>;
+    get(schemaChange: string, options?: RequestOptions): APIPromise<SchemaChangeDetail>;
 }
 /** A collection's search index. */
 export declare class SearchIndexes extends Resource {
@@ -39,7 +39,7 @@ export declare class Fields extends Resource {
     get(field: string, options?: RequestOptions): APIPromise<Field>;
     /**
      * Renames, describes or loosens a field. Changes that rewrite record
-     * values (type, `multiple`, tighter rules) are `migrate`.
+     * values (type, `multiple`, tighter rules) are `migrations.create`.
      */
     update(field: string, params: FieldUpdate, options?: WriteOptions): APIPromise<Field>;
     /**
@@ -54,17 +54,18 @@ export declare class Fields extends Resource {
     reorder(collection: string, params: FieldReorderParams, options?: WriteOptions): APIPromise<FieldOrder>;
     /** Stops accepting a renamed field's old API key before its 6 months end. */
     removeAlias(field: string, alias: string, options?: RequestOptions): APIPromise<Field>;
+}
+/** Field migrations. While one runs, its collection is read-only. */
+export declare class Migrations extends Resource {
     /**
-     * Starts a field migration (type, `multiple`, tighter configuration or a
-     * backfill) that rewrites every record. With `dry_run`, previews it.
+     * Starts a migration of one of the collection's fields (`field_id`): a
+     * type, `multiple`, tighter configuration or a backfill, which rewrites
+     * every record. With `dry_run`, previews it.
      */
-    migrate(field: string, params: FieldMigrateParams & {
+    create(collection: string, params: MigrationCreateParams & {
         dry_run: true;
     }, options?: WriteOptions): APIPromise<FieldMigrationPreview>;
-    migrate(field: string, params: FieldMigrateParams & DryRunParams, options?: WriteOptions): APIPromise<FieldMigration>;
-}
-/** Field migrations. While one runs, its collection is read-only. */
-export declare class Migrations extends Resource {
+    create(collection: string, params: MigrationCreateParams & DryRunParams, options?: WriteOptions): APIPromise<FieldMigration>;
     list(collection: string, params?: ListParams, options?: RequestOptions): PagePromise<FieldMigration>;
     get(migration: string, options?: RequestOptions): APIPromise<FieldMigration>;
     cancel(migration: string, options?: RequestOptions): APIPromise<FieldMigration>;

package/dist/resources/schema.js

@@ -36,10 +36,8 @@ export class SchemaChanges extends Resource {
     list(collection, params = {}, options) {
         return this.core.paginate("schema_changes_list", { path: { collection_id: collection }, query: params }, options);
     }
-    get(collection, schemaChange, options) {
-        return this.core.request("schema_changes_get", {
-            path: { collection_id: collection, schema_change_id: schemaChange },
-        }, options);
+    get(schemaChange, options) {
+        return this.core.request("schema_changes_get", { path: { schema_change_id: schemaChange } }, options);
     }
 }
 /** A collection's search index. */
@@ -68,7 +66,7 @@ export class Fields extends Resource {
     }
     /**
      * Renames, describes or loosens a field. Changes that rewrite record
-     * values (type, `multiple`, tighter rules) are `migrate`.
+     * values (type, `multiple`, tighter rules) are `migrations.create`.
      */
     update(field, params, options) {
         return this.core.request("fields_update", { path: { field_id: field }, body: params }, options);
@@ -95,12 +93,12 @@ export class Fields extends Resource {
     removeAlias(field, alias, options) {
         return this.core.request("fields_remove_alias", { path: { field_id: field, alias } }, options);
     }
-    migrate(field, { dry_run, ...body }, options) {
-        return this.core.request("fields_migrate", { path: { field_id: field }, query: { dry_run }, body }, options);
-    }
 }
 /** Field migrations. While one runs, its collection is read-only. */
 export class Migrations extends Resource {
+    create(collection, { dry_run, ...body }, options) {
+        return this.core.request("migrations_create", { path: { collection_id: collection }, query: { dry_run }, body }, options);
+    }
     list(collection, params = {}, options) {
         return this.core.paginate("migrations_list", { path: { collection_id: collection }, query: params }, options);
     }

package/dist/types.d.ts

@@ -88,8 +88,6 @@ export interface DraftGetParams {
     expand?: string[];
 }
 export interface DraftListParams extends ListParams {
-    /** One record's draft, or several records' (up to 100). */
-    record_id?: string | string[];
     sort?: "updated_at" | "-updated_at";
 }
 export interface DraftScheduleParams {
@@ -155,9 +153,9 @@ export interface DeletedListParams extends ListParams {
 }
 export interface AssetListParams extends DeletedListParams {
     /**
-     * Only assets of these MIME types or `type/*` wildcards, e.g.
-     * `["image/*", "application/pdf"]`, such as an asset field's
-     * `accepted_types`.
+     * Only assets of a MIME type or `type/*` wildcard (`"image/*"`), or of any
+     * of several: `["image/*", "application/pdf"]`, such as an asset
+     * field's `accepted_types`.
      */
     content_type?: string | string[];
 }
@@ -165,7 +163,8 @@ export interface SchemaParams {
     /** A past schema version; the current one otherwise. */
     version?: number;
 }
-export type FieldMigrateParams = G.FieldMigrationRequest;
+/** `field_id`, one of the collection's fields, and the parts of its definition to change. */
+export type MigrationCreateParams = G.FieldMigrationRequest;
 export interface FieldReorderParams {
     /** Every active field of the collection, once each, in the new order. */
     field_ids: string[];
@@ -188,7 +187,8 @@ export interface AuditEventFilter {
 }
 export interface AuditEventListParams extends ListParams {
     filter?: AuditEventFilter;
-    sort?: "id" | "-id";
+    /** Newest first by default (`-created_at`). */
+    sort?: "created_at" | "-created_at";
 }
 /** The metadata of a search page: also an estimate of the total hits. */
 export type SearchMeta = G.SearchResults["meta"];

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.5.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.3.0";
+export const VERSION = "0.5.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nohead/sdk",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Official TypeScript SDK for the Nohead API",
   "license": "MIT",
   "homepage": "https://nohead.io",