@nohead/sdk 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -5,6 +5,22 @@ 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.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

@@ -306,11 +306,11 @@ 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",
 })
 

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

@@ -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";

package/dist/generated/operations.gen.js

@@ -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";