@relyio/sdk 0.18.0 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @relyio/sdk
 
+## 0.20.0
+
+### Minor Changes
+
+- d0114a0: **`relyio.functions` calls are typed.** `relyio generate-types` reads your `relyio/functions/` and its `schema.ts` registers each Function's input and output Fields, so `relyio.functions.checkout({ cartId })` takes and answers what `checkout` declares: a misnamed, missing or mistyped input field, or a Function your project does not declare, is a type error. A project with no Function files stays as it was, its calls untyped. `relyio ci check` compares committed types against the repository's own Functions too.
+
+### Patch Changes
+
+- fd31efe: **`validateFile` accepts a wildcard MIME pattern.** A schema's `allowedMimeTypes: ['image/*']` no longer refuses `image/png` client-side; matching is case-insensitive, ignores `;` parameters and takes `*/*`, as the server's presign does.
+
+## 0.19.0
+
+### Minor Changes
+
+- 0c154b3: **Declare who may read and write each type.** A Record type takes an Owner field, `fields.owner()`, which RelyIO sets from the signed-in End user's token, and `endUsers` names its Policies — `read`, `create`, `update` (with the `fields` an End user may set) and `delete`, each `'owner'`, `'signedIn'`, `'anyone'` (for a read) or a condition built with `conditionRoot('record' | 'claims')`, `and`, `or` and `not`. `perUser.writesPerMinute` caps one End user's writes, and `onOwnerDeleted: 'delete' | 'keep'` says what becomes of their Records when their identity provider deletes them. A content type's `endUsers.read: { when, otherwise }` Gates it: an entry `when` holds of is served whole, any other as its `otherwise` fields with `_gated: true`. The rule types are exported from `@relyio/sdk/schema` as `PolicyRule`, `NamedPolicyRule`, `WriteRule`, `FieldsWriteRule`, `RecordWriteRule`, `RecordTypeEndUsers` and `OwnerDeletedAction`.
+
+  **Private fields.** `private: true` on a field keeps it from every publishable-key read and every End user's, whatever key they come with; your server and your Functions still read it.
+
+  **Clerk's users.** With Clerk in `relyio/extensions.ts`, `clerk.userRef()` declares a reference to a `clerkUser` — the Record RelyIO keeps for each of your Clerk users — and a signed-in End user reads their own `clerkUser`, by its list, by its id, or through an Owner field's include.
+
+  **Refusals you can catch.** A refused End user token is `EndUserTokenInvalidError`, with `reason` (`expired`, `wrong-audience`, `missing`, …). `PublishableKeyRefusedError` now says how to fix it: send the End user's token, declare `endUsers` on the Function, or call from your server. A unique value an End user's write collides with names no `recordId`: it may be a Record they cannot read.
+
+- 6acd363: **Every request carries the signed-in End user's token.** Hand the client your identity provider's token function once — `createClient({ apiKey, getToken })`, Clerk's `getToken` or your own — and each request asks it then: a token is sent as `X-RelyIO-End-User` beside the key, and `null` (or a blank string) sends nothing, so the request is the key's alone. It is asked once per call, so every retry sends the token the first attempt sent; a function that throws rejects the call with nothing sent. It works with a publishable key in a browser and a secret key on a server. `client.with({ getToken })` makes a client that asks its own function in place of its parent's, and `updateConfig({ getToken: null })` stops sending one. A token the API cannot verify is refused `END_USER_TOKEN_INVALID` (401).
+
+  **Claims are typed from `relyio/extensions.ts`.** `ClaimsOf<typeof extensions>` (`@relyio/sdk/extensions`) is an object with one optional key per Claim the identity Extension's `claims` setting names — `oidc: { claims: 'plan, role' }` is `{ plan?: unknown; role?: unknown }` — so `conditionRoot<ClaimsOf<typeof extensions>>('claims').plan.eq('paid')` compiles and a misspelt Claim does not. A setting is text, so a Claim's value is `unknown`.
+
+- 10d761f: **A browser may call a Function that says so.** `defineFunction({ endUsers: 'required', … })` lets a publishable key call it through `relyio.functions.<name>(input)` for a signed-in End user — the call carries their token (`getToken`), and without one it is refused `END_USER_TOKEN_INVALID` (401, reason `missing`); `endUsers: 'optional'` lets it call with or without one. A Function that declares neither is still refused to a publishable key (`PUBLISHABLE_KEY_REFUSED`). The run is bound by the Function's own reach either way — a checkout takes stock the shopper could never write — and the plan names a new or widened `endUsers`.
+
+  **`run.endUser` names who called.** Any call carrying a verified token — with any key, or to a Public route sent one — hands the run `run.endUser`: `{ subject, claims }`, the subject an Owner field stores, and the Claims your `relyio/extensions.ts` declares. Type them by registering it: `declare module '@relyio/sdk' { interface Register { extensions: typeof extensions } }`. A Record the run creates with no owner named is that End user's; name one to set it yourself.
+
 ## 0.18.0
 
 ### Minor Changes

package/dist/automations/index.cjs

@@ -1,70 +1,71 @@
 'use strict';
 
-var chunkLSI26ZN2_cjs = require('../chunk-LSI26ZN2.cjs');
-var chunkZAMAR3X2_cjs = require('../chunk-ZAMAR3X2.cjs');
+var chunkDBYMG6MQ_cjs = require('../chunk-DBYMG6MQ.cjs');
+var chunk5F3YYPLZ_cjs = require('../chunk-5F3YYPLZ.cjs');
+require('../chunk-UO2QRYKV.cjs');
 require('../chunk-L6DXCKVQ.cjs');
 
 
 
 Object.defineProperty(exports, "and", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.and; }
+  get: function () { return chunkDBYMG6MQ_cjs.and; }
 });
 Object.defineProperty(exports, "anyEntry", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.anyEntry; }
+  get: function () { return chunkDBYMG6MQ_cjs.anyEntry; }
 });
 Object.defineProperty(exports, "automations", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.automations; }
+  get: function () { return chunkDBYMG6MQ_cjs.automations; }
 });
 Object.defineProperty(exports, "defineAutomation", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.defineAutomation; }
+  get: function () { return chunkDBYMG6MQ_cjs.defineAutomation; }
 });
 Object.defineProperty(exports, "entries", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.entries; }
+  get: function () { return chunkDBYMG6MQ_cjs.entries; }
 });
 Object.defineProperty(exports, "extensionTrigger", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.extensionTrigger; }
+  get: function () { return chunkDBYMG6MQ_cjs.extensionTrigger; }
 });
 Object.defineProperty(exports, "isAutomationFile", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.isAutomationFile; }
+  get: function () { return chunkDBYMG6MQ_cjs.isAutomationFile; }
 });
 Object.defineProperty(exports, "not", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.not; }
+  get: function () { return chunkDBYMG6MQ_cjs.not; }
 });
 Object.defineProperty(exports, "on", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.on; }
+  get: function () { return chunkDBYMG6MQ_cjs.on; }
 });
 Object.defineProperty(exports, "or", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.or; }
+  get: function () { return chunkDBYMG6MQ_cjs.or; }
 });
 Object.defineProperty(exports, "records", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.records; }
+  get: function () { return chunkDBYMG6MQ_cjs.records; }
 });
 Object.defineProperty(exports, "resolveAutomation", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.resolveAutomation; }
+  get: function () { return chunkDBYMG6MQ_cjs.resolveAutomation; }
 });
 Object.defineProperty(exports, "schedule", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.schedule; }
+  get: function () { return chunkDBYMG6MQ_cjs.schedule; }
 });
 Object.defineProperty(exports, "tpl", {
   enumerable: true,
-  get: function () { return chunkLSI26ZN2_cjs.tpl; }
+  get: function () { return chunkDBYMG6MQ_cjs.tpl; }
 });
 Object.defineProperty(exports, "fields", {
   enumerable: true,
-  get: function () { return chunkZAMAR3X2_cjs.fields; }
+  get: function () { return chunk5F3YYPLZ_cjs.fields; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map