@nohead/sdk 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -5,6 +5,20 @@ 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.8.0
+
+- `Asset` has `file_url`, the file as uploaded, which downloads under its
+  filename, and for video and audio `media_url`, which plays it inline (in
+  `<video>` and `<audio>`, with range requests). Both are open, never expire
+  and are cached on a CDN, like `image_url`.
+
+- `assets.downloadUrl` is removed, with the API's
+  `GET /v1/assets/{asset_id}/download-url` and its 2-minute links: use the
+  asset's `file_url`.
+
+- An upload larger than the plan allows (10 MB a file on Free, 100 MB on paid
+  plans) is refused with a `PlanLimitExceededError` when it starts.
+
 ## 0.7.0
 
 - `assets.list({ q, kind })`: `q` finds assets whose filename or alt text

package/README.md

@@ -372,6 +372,8 @@ Verify a webhook request, then use its event:
 
 ```ts
 // e.g. a Next.js route handler
+import { revalidateTag } from "next/cache"
+
 export async function POST(request: Request) {
   const event = await nohead.webhooks.unwrap(
     await request.text(),
@@ -381,12 +383,14 @@ export async function POST(request: Request) {
     }
   )
   if (event.type === "record.published" && event.data.record) {
-    revalidateTag(event.data.record.collection)
+    revalidateTag(event.data.record.collection, "max")
   }
   return new Response(null, { status: 204 })
 }
 ```
 
+With `"max"`, Next.js serves the old version to the next request while it fetches the new one; pass `{ expire: 0 }` instead to drop it at once.
+
 Event types are those of the activity log (`record.published`, `record.restored`, `field.updated`, `asset.purged`, …), and a webhook subscribes to types or wildcards (`record.*`, `*`). Narrowing by `type` types `event.data`, and `unwrap<Post>` types the records and drafts in it. `unwrap` checks the signature and the timestamp (Standard Webhooks), and throws `WebhookVerificationError` if either is off. After `rotateSecret`, requests carry a signature for the old secret and the new one for 24 hours, so switch the receiver's secret within that day (or end it sooner with `webhooks.secrets.retire`). Pass the raw body: parsing and re-serializing JSON changes the bytes.
 
 A receiver that never calls the API can use `unwrapWebhook` from `@nohead/sdk/webhooks` without a client. Events can arrive more than once, so deduplicate by the `webhook-id` header.
@@ -414,7 +418,7 @@ response.headers.get("RateLimit-Remaining")
 | `collections.searchIndex`   | `get`, `rebuild`                                                                                                                                                                                        |
 | `fields`                    | `list`, `get`, `create`, `update`, `delete`, `restore`, `order`, `reorder`, `removeAlias`                                                                                                               |
 | `migrations`                | `create`, `list`, `get`, `cancel`                                                                                                                                                                       |
-| `assets`                    | `upload`, `createUpload`, `complete`, `list`, `get`, `update`, `delete`, `restore`, `purge`, `usage`, `downloadUrl`                                                                                     |
+| `assets`                    | `upload`, `createUpload`, `complete`, `list`, `get`, `update`, `delete`, `restore`, `purge`, `usage`                                                                                                    |
 | `webhooks`                  | `list`, `get`, `create`, `update`, `delete`, `restore`, `rotateSecret`, `test`, `unwrap`                                                                                                                |
 | `webhooks.secrets`          | `list`, `retire`                                                                                                                                                                                        |
 | `webhooks.deliveries`       | `list`, `get`, `retry`                                                                                                                                                                                  |

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

@@ -8,10 +8,6 @@ export declare const OPERATIONS: {
         readonly method: "DELETE";
         readonly path: "/v1/assets/{asset_id}";
     };
-    readonly assets_download_url: {
-        readonly method: "GET";
-        readonly path: "/v1/assets/{asset_id}/download-url";
-    };
     readonly assets_get: {
         readonly method: "GET";
         readonly path: "/v1/assets/{asset_id}";
@@ -339,10 +335,6 @@ export interface Operations {
         data: T.AssetsDeleteData;
         response: T.AssetsDeleteResponse;
     };
-    assets_download_url: {
-        data: T.AssetsDownloadUrlData;
-        response: T.AssetsDownloadUrlResponse;
-    };
     assets_get: {
         data: T.AssetsGetData;
         response: T.AssetsGetResponse;

package/dist/generated/operations.gen.js

@@ -1,7 +1,6 @@
 export const OPERATIONS = {
     assets_complete: { method: "POST", path: "/v1/assets/{asset_id}/complete" },
     assets_delete: { method: "DELETE", path: "/v1/assets/{asset_id}" },
-    assets_download_url: { method: "GET", path: "/v1/assets/{asset_id}/download-url" },
     assets_get: { method: "GET", path: "/v1/assets/{asset_id}" },
     assets_list: { method: "GET", path: "/v1/projects/{project_id}/assets" },
     assets_purge: { method: "POST", path: "/v1/assets/{asset_id}/purge" },

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

@@ -1 +1 @@
-export type { Actor, ApiKeyScope, Asset, AssetEventData, AssetField, AssetFieldConfiguration, AssetFieldCreate, AssetKind, AssetList, AssetProperties, AssetUpdate, 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, IntegerField, IntegerFieldConfiguration, IntegerFieldCreate, JsonField, JsonFieldConfiguration, JsonFieldCreate, ListMeta, LongTextField, LongTextFieldConfiguration, LongTextFieldCreate, MergedDraft, NullableTimestamp, Principal, PublishedOnly, RecordBatch, RecordBatchRequest, RecordCount, RecordCreate, 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";
+export type { Actor, ApiKeyScope, Asset, AssetEventData, AssetField, AssetFieldConfiguration, AssetFieldCreate, AssetKind, AssetList, AssetProperties, AssetUpdate, AssetUploadCreate, AssetUploadTarget, AssetUsage, AssetWithUpload, AuditEvent, AuditEventList, BooleanField, BooleanFieldConfiguration, BooleanFieldCreate, Change, Collection, CollectionCreate, CollectionList, CollectionUpdate, DateField, DateFieldConfiguration, DateFieldCreate, DecimalField, DecimalFieldConfiguration, DecimalFieldCreate, 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, IntegerField, IntegerFieldConfiguration, IntegerFieldCreate, JsonField, JsonFieldConfiguration, JsonFieldCreate, ListMeta, LongTextField, LongTextFieldConfiguration, LongTextFieldCreate, MergedDraft, NullableTimestamp, Principal, PublishedOnly, RecordBatch, RecordBatchRequest, RecordCount, RecordCreate, 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";

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

@@ -1539,6 +1539,22 @@ export type AssetProperties = {
      * The URL of a small rendition (fits in 640×640, WebP), for ready images and SVGs (rasterized; SVGs have no `image_url`), deleted ones included until they are purged; null otherwise.
      */
     preview_url: string | null;
+    /**
+     * The URL of the file as uploaded, for ready assets of any type,
+     * deleted ones included until they are purged; null otherwise. It
+     * downloads the file under its `filename` (a rename applies within a
+     * minute or so), is open and never expires, and is cached on a CDN.
+     *
+     */
+    file_url: string | null;
+    /**
+     * The URL that plays a ready video or audio file inline, for
+     * `<video>` and `<audio>` (with range requests, so players can seek),
+     * deleted ones included until they are purged; null for other types.
+     * Open, never expiring and cached on a CDN, like `file_url`.
+     *
+     */
+    media_url: string | null;
     uploaded_at: NullableTimestamp;
     created_at: Timestamp;
     updated_at: Timestamp;
@@ -1569,17 +1585,11 @@ export type AssetUsage = {
         fields: Array<string>;
     }>;
 };
-export type DownloadUrl = {
-    object: 'download_url';
-    asset_id: string;
-    url: string;
-    expires_at: Timestamp;
-};
 export type AssetUploadCreate = {
     filename: string;
     content_type: string;
     /**
-     * Exact size of the file in bytes (at most 100 MB by default).
+     * Exact size of the file in bytes, at most the plan's largest upload (10 MB on Free, 100 MB on paid plans).
      */
     byte_size: number;
 };
@@ -5741,55 +5751,6 @@ export type AssetsUpdateResponses = {
     200: Asset;
 };
 export type AssetsUpdateResponse = AssetsUpdateResponses[keyof AssetsUpdateResponses];
-export type AssetsDownloadUrlData = {
-    body?: never;
-    path: {
-        asset_id: string;
-    };
-    query?: never;
-    url: '/v1/assets/{asset_id}/download-url';
-};
-export type AssetsDownloadUrlErrors = {
-    /**
-     * The request was malformed: unparseable JSON, an invalid query parameter, or a body key the operation doesn't take (detail code `unknown_parameter`, naming the key).
-     */
-    400: Error;
-    /**
-     * Authentication is missing or invalid.
-     */
-    401: Error;
-    /**
-     * The caller is not allowed to perform this action.
-     */
-    403: Error;
-    /**
-     * The resource does not exist or is not visible to the caller.
-     */
-    404: Error;
-    /**
-     * The request conflicts with current state.
-     */
-    409: Error;
-    /**
-     * Too many requests for this API key or user (or, with failing
-     * credentials, this IP address). A published-only key is counted per
-     * client IP. Wait `Retry-After` seconds; retries with the same `Idempotency-Key`
-     * are safe. On the Free plan, an organization's API keys are also
-     * refused once its API requests reach the month's limit, with a
-     * `plan_limit` detail (`field` `api_requests`, `usage` and `limit`),
-     * until the next month (UTC) or an upgrade.
-     *
-     */
-    429: Error;
-};
-export type AssetsDownloadUrlError = AssetsDownloadUrlErrors[keyof AssetsDownloadUrlErrors];
-export type AssetsDownloadUrlResponses = {
-    /**
-     * The download URL.
-     */
-    200: DownloadUrl;
-};
-export type AssetsDownloadUrlResponse = AssetsDownloadUrlResponses[keyof AssetsDownloadUrlResponses];
 export type AssetsUsageData = {
     body?: never;
     path: {

package/dist/resources/assets.d.ts

@@ -1,6 +1,6 @@
 import type { APIPromise, PagePromise } from "../api-promise.ts";
 import type { RequestOptions } from "../core.ts";
-import type { Asset, AssetUpdate, AssetUploadCreate, AssetWithUpload, AssetUsage, DownloadUrl } from "../generated/types.gen.ts";
+import type { Asset, AssetUpdate, AssetUploadCreate, AssetWithUpload, AssetUsage } from "../generated/types.gen.ts";
 import type { AssetListParams } from "../types.ts";
 import { Resource } from "./resource.ts";
 /** What `assets.upload` accepts. A stream needs `byte_size`. */
@@ -69,6 +69,4 @@ export declare class Assets extends Resource {
      * updated with the fields that use it (`uses`). Needs `records:read` too.
      */
     usage(asset: string, options?: RequestOptions): APIPromise<AssetUsage>;
-    /** A link to download the original file (`url`), valid for 2 minutes. */
-    downloadUrl(asset: string, options?: RequestOptions): APIPromise<DownloadUrl>;
 }

package/dist/resources/assets.js

@@ -159,10 +159,6 @@ export class Assets extends Resource {
     usage(asset, options) {
         return this.core.request("assets_usage", { path: { asset_id: asset } }, options);
     }
-    /** A link to download the original file (`url`), valid for 2 minutes. */
-    downloadUrl(asset, options) {
-        return this.core.request("assets_download_url", { path: { asset_id: asset } }, options);
-    }
 }
 function sizeOf(file) {
     if (file instanceof Blob)

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.7.0";
+export declare const VERSION = "0.8.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.7.0";
+export const VERSION = "0.8.0";

package/package.json

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