@raytio/types 6.0.0 → 6.0.1

package/README.md

@@ -41,6 +41,7 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Instance](#instance)
 - [Lookup](#lookup)
 - [NId](#nid)
+- [OId](#oid)
 - [Organization](#organization)
 - [PId](#pid)
 - [ProfileObject](#profileobject)
@@ -76,10 +77,11 @@ Hovering over the type in VSCode will display documentation and available proper
 | `a_id` | [`AId`](#aid) | - |
 | `aa_help?` | `string` | markdown or string help information including [phoneNumber || email] |
 | `aa_introduction?` | `string` | If a user signs up while completing this form, this message will be sent in the sign up email. |
+| `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
 | `callback_uri?` | `string`[] | - |
 | `description?` | `string` | - |
 | `name` | `string` | - |
-| `org_id` | `string` | the id of the associated organisation |
+| `org_id` | [`OId`](#oid) | the id of the associated organisation |
 | `picture?` | [`Urn`](#urn) | - |
 | `picture_url?` | `string` | Easy to use AA logo url for pasting inot emails |
 | `ruleset?` | `unknown` | configuration for the submission rules |
@@ -260,6 +262,14 @@ An `n_id` is the ID of a @see ProfileObject
 
 ___
 
+### OId
+
+Ƭ **OId**: `StringWithIdentity`<``"OId"``\>
+
+An `o_id` is the ID of an @see Organization
+
+___
+
 ### Organization
 
 Ƭ **Organization**: `Object`
@@ -280,7 +290,7 @@ NOTE: this is different to how the schema defines an Organization. **The schema
 | `address.street2` | `string` |
 | `customer` | `Record`<`string`, `unknown`\> |
 | `email` | `string` |
-| `id` | `string` |
+| `id` | [`OId`](#oid) |
 | `name` | `string` |
 
 ___
@@ -416,6 +426,8 @@ Raytio's variant of JSON Schema. All props marked as optional except
 | `title_plural?` | `string` | plural version of the title |
 | `type?` | [`DataTypes`](#datatypes) | - |
 | `verified_fields?` | (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] | originally `string[]`, the client modifies this |
+| `version?` | `string` | - |
+| `version_current?` | `boolean` | whether the `version` is the latest version |
 | `wasExpandedByClient?` | `boolean` | - |
 
 ___
@@ -470,7 +482,7 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:terms_conditions"`` \| ``"display:showOnWizard"`` \| \`display:main\_media:${string}\` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:extract_required"``
+Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:terms_conditions"`` \| ``"display:showOnWizard"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
 
 ___
 
@@ -484,7 +496,7 @@ ___
 
 ### SchemaTag
 
-Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
+Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
 
 ___
 
@@ -571,7 +583,7 @@ These `n_id`s point to service provider profile objects
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `dataSourceNId?` | [`NId`](#nid) | - |
-| `date` | `Date` | the date which the verification was verified on, or last re-verified on |
+| `date?` | `Date` | the date which the verification was verified on, or last re-verified on |
 | `serviceProviderNId?` | [`NId`](#nid) | - |
 | `verifierNId?` | [`NId`](#nid) | - |
 

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/raytio.d.ts

@@ -18,6 +18,8 @@ export declare type GId = StringWithIdentity<"GId">;
 export declare type UId = StringWithIdentity<"UId">;
 /** An `a_id` is the ID of an @see AA */
 export declare type AId = StringWithIdentity<"AId">;
+/** An `o_id` is the ID of an @see Organization */
+export declare type OId = StringWithIdentity<"OId">;
 export declare type DataTypes = "string" | "number" | "boolean" | "object" | "integer" | "array" | "null";
 export declare type SubmissionStatus = "Submitted" | "Processing" | "Rejected" | "Expired" | "Completed" | "DataChanged" | "Received" | "Accepted";
 /** You can supply an option type argument if you know exactly what the properties will be */
@@ -99,9 +101,11 @@ export declare type AA = {
     /** the n_id of the associated service provider */
     service_provider_n_id?: NId;
     /** the id of the associated organisation */
-    org_id: string;
+    org_id: OId;
     /** configuration for the submission rules */
     ruleset?: unknown;
+    /** if true, only specific email addresses can submit the form */
+    auth_list_enabled?: boolean;
     /** @internal */
     _transitions?: unknown[];
 };
@@ -150,7 +154,7 @@ export declare type Instance = {
  * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
  */
 export declare type Organization = {
-    id: string;
+    id: OId;
     name: string;
     email: string;
     address: {

package/dist/schema.d.ts

@@ -7,8 +7,8 @@ export declare type ConditionallyRequired = {
         [fieldName: string]: string[];
     };
 };
-export declare type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:terms_conditions" | "display:showOnWizard" | `display:main_media:${string}` | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:extract_required";
-export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
+export declare type SchemaFieldTag = "password" | `group:${string}` | `upload-group:${string}` | "display:stars" | "display:no_autofill" | "display:currency" | "display:cascade" | "display:survey" | "display:quoting" | "display:customModal" | "display:terms_conditions" | "display:showOnWizard" | `display:main_media:${string}` | "date_component:day" | "date_component:month" | "date_component:year" | "action:client_upload" | "verify:show_if_pending" | "special:hide_select_behind_button" | "type:capture_geolocation" | "type:extract_required";
+export declare type SchemaTag = "action:experimental_pass_object_store_id" | "action:verify" | "default_camera:rear" | "default_camera:front" | `oauth2_component:name:${string}` | `oauth2_component:redirect_url:${string}` | `link_to:${string}:${string}` | "type:service_provider" | "type:service_offer" | "type:marketplace" | "type:client_only" | "type:globally_unique_field";
 export declare type SchemaField = {
     /** @deprecated don't use, it's inconsistent */
     $id?: string;
@@ -122,6 +122,9 @@ export declare type Schema = {
     group_title?: string;
     /** @deprecated not sure why a schema would have this, only fields should */
     $ref?: string;
+    version?: string;
+    /** whether the `version` is the latest version */
+    version_current?: boolean;
     tags?: SchemaTag[];
     /** originally `string[]`, the client modifies this */
     verified_fields?: (string | ConditionallyRequired)[];

package/dist/verification.d.ts

@@ -69,7 +69,7 @@ export declare type VerificationProvider = {
     dataSourceNId?: NId;
     serviceProviderNId?: NId;
     /** the date which the verification was verified on, or last re-verified on */
-    date: Date;
+    date?: Date;
 };
 /** This is what @raytio/core exposes, which is more useable than @see Verification */
 export declare type RealVer = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/types",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "license": "MIT",
   "main": "index",
   "types": "index",

package/src/raytio.ts

@@ -19,6 +19,8 @@ export type GId = StringWithIdentity<"GId">;
 export type UId = StringWithIdentity<"UId">;
 /** An `a_id` is the ID of an @see AA */
 export type AId = StringWithIdentity<"AId">;
+/** An `o_id` is the ID of an @see Organization */
+export type OId = StringWithIdentity<"OId">;
 
 export type DataTypes =
   | "string"
@@ -134,12 +136,15 @@ export type AA = {
   /** the n_id of the associated service provider */
   service_provider_n_id?: NId;
   /** the id of the associated organisation */
-  org_id: string;
+  org_id: OId;
 
   /** configuration for the submission rules */
   // we know the type should be `ScoreConfig`, but we can't rely that it's valid, or the right version
   ruleset?: unknown;
 
+  /** if true, only specific email addresses can submit the form */
+  auth_list_enabled?: boolean;
+
   /** @internal */
   _transitions?: unknown[];
 };
@@ -192,7 +197,7 @@ export type Instance = {
  * NOTE: this is different to how the schema defines an Organization. **The schema is wrong (see #468)**
  */
 export type Organization = {
-  id: string;
+  id: OId;
   name: string;
   email: string;
   address: {

package/src/schema.ts

@@ -26,10 +26,15 @@ export type SchemaFieldTag =
   | "display:terms_conditions"
   | "display:showOnWizard" // added by #837, TODO: document
   | `display:main_media:${string}` // property name to determine what image to display
+  // date picker components
+  | "date_component:day"
+  | "date_component:month"
+  | "date_component:year"
   // other
   | "action:client_upload"
   | "verify:show_if_pending"
   | "special:hide_select_behind_button"
+  | "type:capture_geolocation" // triggers the wizard's GeoLocationInput field
   | "type:extract_required";
 
 export type SchemaTag =
@@ -39,6 +44,9 @@ export type SchemaTag =
   // camera
   | "default_camera:rear"
   | "default_camera:front"
+  // oauth group rule
+  | `oauth2_component:name:${string}`
+  | `oauth2_component:redirect_url:${string}`
   // misc
   | `link_to:${/* schemaName */ string}:${/* relationshipType */ string}`
   // type
@@ -171,6 +179,10 @@ export type Schema = {
   /** @deprecated not sure why a schema would have this, only fields should */
   $ref?: string;
 
+  version?: string;
+  /** whether the `version` is the latest version */
+  version_current?: boolean;
+
   tags?: SchemaTag[];
   /** originally `string[]`, the client modifies this */
   verified_fields?: (string | ConditionallyRequired)[];

package/src/verification.ts

@@ -82,7 +82,7 @@ export type VerificationProvider = {
   dataSourceNId?: NId;
   serviceProviderNId?: NId;
   /** the date which the verification was verified on, or last re-verified on */
-  date: Date;
+  date?: Date;
 };
 
 /** This is what @raytio/core exposes, which is more useable than @see Verification */