@nohead/sdk 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -5,6 +5,42 @@ Changes to `@nohead/sdk` that you can notice. Versions follow
 releases; a change that could break your code is a major one. Each release's
 section is its GitHub release's notes.
 
+## 0.5.0
+
+- **Breaking:** field migrations are created under their collection:
+  `migrations.create(collection, { field_id, ...changes, dry_run? })`
+  (`POST /v1/collections/{collection_id}/migrations`) replaces
+  `fields.migrate(field, ...)`. It returns a preview for a dry run and the
+  `FieldMigration` otherwise, as before. `FieldMigrateParams` is
+  `MigrationCreateParams`, with `field_id`.
+- **Breaking:** `drafts.list` no longer takes `record_id`; a record's drafts
+  are `records.drafts(record)`.
+- **Breaking:** `assets.list`'s `content_type` is one MIME type or `type/*`
+  wildcard as a string, or several as a list (sent as
+  `filter[content_type][in]`). A comma-separated string no longer lists
+  several types: pass a list.
+- **Breaking:** `auditEvents.list` sorts by `created_at` or `-created_at`
+  (the default), not `id`, and records no longer sort by `id`.
+- Webhook events always carry `actor` and `via` (now required in
+  `WebhookEventPayload`), and `Via` no longer has `import` or `migration`,
+  which were never sent.
+
+## 0.4.0
+
+- **Breaking:** a field's `api_key` is its `key` (in fields, their aliases,
+  `fields.create` and `fields.update`), as the editor's "Field key" says.
+  API keys keep their name.
+- **Breaking:** `collections.schemaChanges.get(schemaChange)` takes the
+  schema change's ID alone (`GET /v1/schema-changes/{id}`).
+- **Breaking:** `fields.update` no longer takes `type` or `multiple`; they
+  rewrite record values, so they are `fields.migrate`. The API refuses a
+  body key an operation doesn't take with `400` (`unknown_parameter`, naming
+  it), so a misspelt key no longer passes unnoticed.
+- `Field` and `FieldCreate` are typed per field type: narrowing on
+  `field.type` types its `configuration` (`if (field.type === "enum")
+field.configuration.options`), and `EnumFieldConfiguration`,
+  `RelationFieldConfiguration`... are exported.
+
 ## 0.3.0
 
 - **Breaking:** 0.1.0 and 0.2.0 no longer work with the API: its paths and

package/README.md

@@ -118,7 +118,7 @@ await nohead.drafts.merge(draft.id) // or drafts.schedule(draft.id, { merge_at }
 
 - A record has at most one draft; starting a second is a `ConflictError` (detail code `draft_exists`, with its `draft_id`).
 - A merge changes content only: a live record stays live, an unpublished one unpublished. Publishing a live record with a pending draft is a `ConflictError` (`draft_pending`).
-- `records.drafts(id)` lists a record's draft, and `drafts.list(collection, { record_id })` a collection's (`record_id` takes up to 100 IDs).
+- `records.drafts(id)` lists a record's draft, and `drafts.list(collection)` a collection's.
 - `drafts.discard` deletes one for good.
 - Drafts take the type of their data as records do: `drafts.get<Post>(id)` is a `Nohead.Draft<Post>` (also exported as `NoheadDraft`).
 
@@ -306,20 +306,24 @@ Search needs `search_enabled` collections and the `search:read` scope. It pages
 const posts = await nohead.collections.create({
   name: "Posts",
   slug: "posts",
-  fields: [{ name: "Title", api_key: "title", type: "text", required: true }],
+  fields: [{ name: "Title", key: "title", type: "text", required: true }],
 })
 await nohead.fields.create("posts", {
   name: "Summary",
-  api_key: "summary",
+  key: "summary",
   type: "long_text",
 })
 
 // Changes that rewrite records go through a migration; preview first
-const preview = await nohead.fields.migrate("fld_…", {
+const preview = await nohead.migrations.create("posts", {
+  field_id: "fld_…",
   type: "long_text",
   dry_run: true,
 })
-const migration = await nohead.fields.migrate("fld_…", { type: "long_text" })
+const migration = await nohead.migrations.create("posts", {
+  field_id: "fld_…",
+  type: "long_text",
+})
 await nohead.migrations.get(migration.id)
 ```
 
@@ -370,8 +374,8 @@ response.headers.get("RateLimit-Remaining")
 | `collections`               | `list`, `get`, `create`, `update`, `delete`, `restore`, `schema`                                                                                                                                        |
 | `collections.schemaChanges` | `list`, `get`                                                                                                                                                                                           |
 | `collections.searchIndex`   | `get`, `rebuild`                                                                                                                                                                                        |
-| `fields`                    | `list`, `get`, `create`, `update`, `delete`, `restore`, `order`, `reorder`, `removeAlias`, `migrate`                                                                                                    |
-| `migrations`                | `list`, `get`, `cancel`                                                                                                                                                                                 |
+| `fields`                    | `list`, `get`, `create`, `update`, `delete`, `restore`, `order`, `reorder`, `removeAlias`                                                                                                               |
+| `migrations`                | `create`, `list`, `get`, `cancel`                                                                                                                                                                       |
 | `assets`                    | `upload`, `createUpload`, `complete`, `list`, `get`, `delete`, `restore`, `purge`, `usage`, `imageUrl`, `downloadUrl`                                                                                   |
 | `webhooks`                  | `list`, `get`, `create`, `update`, `delete`, `restore`, `rotateSecret`, `test`, `unwrap`                                                                                                                |
 | `webhooks.secrets`          | `list`, `retire`                                                                                                                                                                                        |

package/dist/core.js

@@ -178,6 +178,11 @@ export class Core {
     }
     async #path(template, values = {}) {
         let path = template;
+        const names = [...template.matchAll(/\{(\w+)\}/g)].map(([, name]) => name);
+        // A value the template doesn't take is a method out of step with its operation.
+        for (const name of Object.keys(values))
+            if (!names.includes(name))
+                throw new TypeError(`${name} is not a path parameter of ${template}`);
         for (const [, name] of template.matchAll(/\{(\w+)\}/g)) {
             let value = values[name];
             if (value === undefined && name === "project_id") {

package/dist/generated/operations.gen.d.ts

@@ -132,10 +132,6 @@ export declare const OPERATIONS: {
         readonly method: "GET";
         readonly path: "/v1/collections/{collection_id}/fields";
     };
-    readonly fields_migrate: {
-        readonly method: "POST";
-        readonly path: "/v1/fields/{field_id}/migrations";
-    };
     readonly fields_remove_alias: {
         readonly method: "DELETE";
         readonly path: "/v1/fields/{field_id}/aliases/{alias}";
@@ -164,6 +160,10 @@ export declare const OPERATIONS: {
         readonly method: "POST";
         readonly path: "/v1/migrations/{migration_id}/cancel";
     };
+    readonly migrations_create: {
+        readonly method: "POST";
+        readonly path: "/v1/collections/{collection_id}/migrations";
+    };
     readonly migrations_get: {
         readonly method: "GET";
         readonly path: "/v1/migrations/{migration_id}";
@@ -258,7 +258,7 @@ export declare const OPERATIONS: {
     };
     readonly schema_changes_get: {
         readonly method: "GET";
-        readonly path: "/v1/collections/{collection_id}/schema-changes/{schema_change_id}";
+        readonly path: "/v1/schema-changes/{schema_change_id}";
     };
     readonly schema_changes_list: {
         readonly method: "GET";
@@ -459,10 +459,6 @@ export interface Operations {
         data: T.FieldsListData;
         response: T.FieldsListResponse;
     };
-    fields_migrate: {
-        data: T.FieldsMigrateData;
-        response: T.FieldsMigrateResponse;
-    };
     fields_remove_alias: {
         data: T.FieldsRemoveAliasData;
         response: T.FieldsRemoveAliasResponse;
@@ -491,6 +487,10 @@ export interface Operations {
         data: T.MigrationsCancelData;
         response: T.MigrationsCancelResponse;
     };
+    migrations_create: {
+        data: T.MigrationsCreateData;
+        response: T.MigrationsCreateResponse;
+    };
     migrations_get: {
         data: T.MigrationsGetData;
         response: T.MigrationsGetResponse;

package/dist/generated/operations.gen.js

@@ -32,7 +32,6 @@ export const OPERATIONS = {
     fields_get: { method: "GET", path: "/v1/fields/{field_id}" },
     fields_get_order: { method: "GET", path: "/v1/collections/{collection_id}/field-order" },
     fields_list: { method: "GET", path: "/v1/collections/{collection_id}/fields" },
-    fields_migrate: { method: "POST", path: "/v1/fields/{field_id}/migrations" },
     fields_remove_alias: { method: "DELETE", path: "/v1/fields/{field_id}/aliases/{alias}" },
     fields_reorder: { method: "PUT", path: "/v1/collections/{collection_id}/field-order" },
     fields_restore: { method: "POST", path: "/v1/fields/{field_id}/restore" },
@@ -40,6 +39,7 @@ export const OPERATIONS = {
     health_check: { method: "GET", path: "/v1/health" },
     me_get: { method: "GET", path: "/v1/me" },
     migrations_cancel: { method: "POST", path: "/v1/migrations/{migration_id}/cancel" },
+    migrations_create: { method: "POST", path: "/v1/collections/{collection_id}/migrations" },
     migrations_get: { method: "GET", path: "/v1/migrations/{migration_id}" },
     migrations_list: { method: "GET", path: "/v1/collections/{collection_id}/migrations" },
     projects_search: { method: "GET", path: "/v1/projects/{project_id}/search" },
@@ -63,7 +63,7 @@ export const OPERATIONS = {
     records_unschedule: { method: "DELETE", path: "/v1/records/{record_id}/schedule" },
     records_update: { method: "PATCH", path: "/v1/records/{record_id}" },
     scheduled_changes_list: { method: "GET", path: "/v1/collections/{collection_id}/scheduled-changes" },
-    schema_changes_get: { method: "GET", path: "/v1/collections/{collection_id}/schema-changes/{schema_change_id}" },
+    schema_changes_get: { method: "GET", path: "/v1/schema-changes/{schema_change_id}" },
     schema_changes_list: { method: "GET", path: "/v1/collections/{collection_id}/schema-changes" },
     search_index_get: { method: "GET", path: "/v1/collections/{collection_id}/search-index" },
     search_index_rebuild: { method: "POST", path: "/v1/collections/{collection_id}/search-index/rebuild" },

package/dist/generated/schemas.gen.d.ts

@@ -1 +1 @@
-export type { Actor, ApiKeyScope, Asset, AssetEventData, AssetList, AssetProperties, AssetUploadCreate, AssetUploadTarget, AssetUsage, AssetWithUpload, AuditEvent, AuditEventList, Change, Collection, CollectionCreate, CollectionList, CollectionUpdate, DownloadUrl, Draft, DraftCreate, DraftEventData, DraftList, DraftSchedule, DraftScheduleUpdate, Error, ErrorDetail, ErrorType, FeatureFlags, Field, FieldAliasEventData, FieldCreate, FieldDefinition, FieldList, FieldMigration, FieldMigrationCounts, FieldMigrationList, FieldMigrationPreview, FieldMigrationRequest, FieldOrder, FieldType, FieldUpdate, Health, ImageUrl, ListMeta, MergedDraft, NullableTimestamp, Principal, PublishedOnly, RecordBatch, RecordBatchRequest, RecordCount, RecordData, RecordDiff, RecordEventData, RecordFilterValue, RecordList, RecordPublication, RecordRevision, RecordRevisionDetail, RecordRevisionList, RecordRevisionOperation, RecordRevisionProperties, RecordSchedule, RecordScheduleUpdate, RecordWrite, RequestId, RevertPreview, ScheduledChange, ScheduledChangeList, Schema, SchemaChange, SchemaChangeDetail, SchemaChangeList, SchemaChangeProperties, SchemaDefinition, SchemaEventData, SearchIndex, SearchResults, TimeFilter, Timestamp, Via, Webhook, WebhookCreate, WebhookDelivery, WebhookDeliveryDetail, WebhookDeliveryList, WebhookDeliveryProperties, WebhookEventPayload, WebhookEventType, WebhookList, WebhookProperties, WebhookSecret, WebhookSecretList, WebhookSecretProperties, WebhookSecretWithValue, WebhookSubscription, WebhookTestEventData, WebhookUpdate, WebhookWithSecret, } from "./types.gen.ts";
+export type { Actor, ApiKeyScope, Asset, AssetEventData, AssetField, AssetFieldConfiguration, AssetFieldCreate, AssetList, AssetProperties, AssetUploadCreate, AssetUploadTarget, AssetUsage, AssetWithUpload, AuditEvent, AuditEventList, BooleanField, BooleanFieldConfiguration, BooleanFieldCreate, Change, Collection, CollectionCreate, CollectionList, CollectionUpdate, DateField, DateFieldConfiguration, DateFieldCreate, DecimalField, DecimalFieldConfiguration, DecimalFieldCreate, DownloadUrl, Draft, DraftCreate, DraftEventData, DraftList, DraftSchedule, DraftScheduleUpdate, EnumField, EnumFieldConfiguration, EnumFieldCreate, Error, ErrorDetail, ErrorType, FeatureFlags, Field, FieldAliasEventData, FieldConfiguration, FieldCreate, FieldCreateProperties, FieldDefinition, FieldList, FieldMigration, FieldMigrationCounts, FieldMigrationList, FieldMigrationPreview, FieldMigrationRequest, FieldOrder, FieldProperties, FieldType, FieldUpdate, Health, ImageUrl, IntegerField, IntegerFieldConfiguration, IntegerFieldCreate, JsonField, JsonFieldConfiguration, JsonFieldCreate, ListMeta, LongTextField, LongTextFieldConfiguration, LongTextFieldCreate, MergedDraft, NullableTimestamp, Principal, PublishedOnly, RecordBatch, RecordBatchRequest, RecordCount, RecordData, RecordDiff, RecordEventData, RecordFilterValue, RecordList, RecordPublication, RecordRevision, RecordRevisionDetail, RecordRevisionList, RecordRevisionOperation, RecordRevisionProperties, RecordSchedule, RecordScheduleUpdate, RecordWrite, RelationField, RelationFieldConfiguration, RelationFieldCreate, RequestId, RevertPreview, RichTextField, RichTextFieldConfiguration, RichTextFieldCreate, ScheduledChange, ScheduledChangeList, Schema, SchemaChange, SchemaChangeDetail, SchemaChangeList, SchemaChangeProperties, SchemaDefinition, SchemaEventData, SearchIndex, SearchResults, TextField, TextFieldConfiguration, TextFieldCreate, TimeFilter, Timestamp, Via, Webhook, WebhookCreate, WebhookDelivery, WebhookDeliveryDetail, WebhookDeliveryList, WebhookDeliveryProperties, WebhookEventPayload, WebhookEventType, WebhookList, WebhookProperties, WebhookSecret, WebhookSecretList, WebhookSecretProperties, WebhookSecretWithValue, WebhookSubscription, WebhookTestEventData, WebhookUpdate, WebhookWithSecret, } from "./types.gen.ts";