@casual-simulation/aux-records 3.1.35 → 3.2.0

package/DataRecordsController.d.ts

@@ -54,20 +54,72 @@ export declare class DataRecordsController {
      */
     eraseData(recordKeyOrName: string, address: string, subjectId: string, instances?: string[]): Promise<EraseDataResult>;
 }
+/**
+ * The possible results of a record data request.
+ *
+ * @dochash types/records/data
+ * @doctitle Data Types
+ * @docsidebar Data
+ * @docdescription Data records are used to store key/value pairs of data.
+ * @docgroup 01-create
+ * @order 0
+ * @docname RecordDataResult
+ */
 export type RecordDataResult = RecordDataSuccess | RecordDataFailure;
+/**
+ * Defines an interface that represents a successful "record data" result.
+ *
+ * @dochash types/records/data
+ * @docgroup 01-create
+ * @order 1
+ * @docname RecordDataSuccess
+ */
 export interface RecordDataSuccess {
     success: true;
+    /**
+     * The name of the record that the data was recorded to.
+     */
     recordName: string;
+    /**
+     * The address that the data is stored at.
+     */
     address: string;
 }
+/**
+ * Defines an interface that represents a failed "record data" result.
+ *
+ * @dochash types/records/data
+ * @docgroup 01-create
+ * @order 2
+ * @docname RecordDataFailure
+ */
 export interface RecordDataFailure {
     success: false;
+    /**
+     * The error code for the failure.
+     */
     errorCode: ServerError | NotLoggedInError | NotAuthorizedError | ValidatePublicRecordKeyFailure['errorCode'] | SetDataResult['errorCode'] | 'unacceptable_request' | 'not_supported' | 'invalid_update_policy' | 'invalid_delete_policy';
+    /**
+     * The error message for the failure.
+     */
     errorMessage: string;
 }
+/**
+ * The possible results of a get data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 02-get
+ * @order 0
+ * @docname GetDataResult
+ */
 export type GetDataResult = GetDataSuccess | GetDataFailure;
 /**
  * Defines an interface that represents a successful "get data" result.
+ *
+ * @dochash types/records/data
+ * @docgroup 02-get
+ * @order 1
+ * @docname GetDataSuccess
  */
 export interface GetDataSuccess {
     success: true;
@@ -100,32 +152,112 @@ export interface GetDataSuccess {
      */
     markers: string[];
 }
+/**
+ * Defines an interface that repeesents a failed "get data" result.
+ *
+ * @dochash types/records/data
+ * @docgroup 02-get
+ * @order 3
+ * @docname GetDataFailure
+ */
 export interface GetDataFailure {
     success: false;
+    /**
+     * The error code for the failure.
+     */
     errorCode: ServerError | GetDataStoreResult['errorCode'] | AuthorizeDenied['errorCode'] | 'not_supported';
+    /**
+     * The error message for the failure.
+     */
     errorMessage: string;
 }
+/**
+ * The possible results of an erase data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 03-erase
+ * @order 0
+ * @docname EraseDataResult
+ */
 export type EraseDataResult = EraseDataSuccess | EraseDataFailure;
+/**
+ * Defines an interface that represents a successful result for an erase data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 03-erase
+ * @order 1
+ * @docname EraseDataSuccess
+ */
 export interface EraseDataSuccess {
     success: true;
+    /**
+     * The name of the record that the data was erased from.
+     */
     recordName: string;
+    /**
+     * The address of the data that was erased.
+     */
     address: string;
 }
+/**
+ * Defines an interface that represents a failed result for an erase data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 03-erase
+ * @order 2
+ * @docname EraseDataFailure
+ */
 export interface EraseDataFailure {
     success: false;
+    /**
+     * The error code for the failure.
+     */
     errorCode: ServerError | NotLoggedInError | NotAuthorizedError | EraseDataStoreResult['errorCode'] | ValidatePublicRecordKeyFailure['errorCode'] | AuthorizeDenied['errorCode'];
+    /**
+     * The error message for the failure.
+     */
     errorMessage: string;
 }
+/**
+ * The possible results of a list data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 04-list
+ * @order 0
+ * @docname ListDataResult
+ */
 export type ListDataResult = ListDataSuccess | ListDataFailure;
+/**
+ * Defines an interface that represents a successful result for a list data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 04-list
+ * @order 1
+ * @docname ListDataSuccess
+ */
 export interface ListDataSuccess {
     success: true;
+    /**
+     * The name of the record that the data was listed from.
+     */
     recordName: string;
+    /**
+     * The items that were listed.
+     */
     items: {
         data: any;
         address: string;
         markers: string[];
     }[];
 }
+/**
+ * Defines an interface that represents a failed result for a list data request.
+ *
+ * @dochash types/records/data
+ * @docgroup 04-list
+ * @order 2
+ * @docname ListDataFailure
+ */
 export interface ListDataFailure {
     success: false;
     errorCode: ServerError | ListDataStoreResult['errorCode'] | AuthorizeDenied['errorCode'] | 'not_supported';

package/DataRecordsController.js

@@ -334,7 +334,8 @@ export class DataRecordsController {
                 }
                 if (existingRecord.success) {
                     const existingDeletePolicy = (_b = existingRecord.deletePolicy) !== null && _b !== void 0 ? _b : true;
-                    if (subjectId !== authorization.recordKeyOwnerId &&
+                    if (subjectId !== context.context.recordOwnerId &&
+                        subjectId !== authorization.recordKeyOwnerId &&
                         !doesSubjectMatchPolicy(existingDeletePolicy, subjectId)) {
                         return {
                             success: false,

package/DataRecordsController.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataRecordsController.js","sourceRoot":"","sources":["DataRecordsController.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAOH,sBAAsB,EACtB,iBAAiB,GACpB,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAQH,yBAAyB,GAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAK9B;;;;OAIG;IACH,YAAY,QAA0B,EAAE,KAAuB;QAC3D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;OAWG;IACG,UAAU,CACZ,qBAA6B,EAC7B,OAAe,EACf,IAAY,EACZ,SAAiB,EACjB,YAAwB,EACxB,YAAwB,EACxB,UAAoB,IAAI,EACxB,YAAsB,IAAI;;;YAE1B,IAAI;gBACA,MAAM,WAAW,GAAyC;oBACtD,qBAAqB;oBACrB,MAAM,EAAE,SAAS;oBACjB,SAAS;iBACZ,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC7D,WAAW,CACd,CAAC;gBAEF,yDAAyD;gBACzD,6BAA6B;gBAC7B,6BAA6B;gBAC7B,wBAAwB;gBACxB,yBAAyB;gBACzB,uBAAuB;gBACvB,MAAM;gBAEN,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO,MAAM,CAAC;iBACjB;gBAED,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;gBAE5C,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,aAAa,EAAE;oBACxC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,SAAS,GAAG,IAAI,CAAC;iBACpB;gBAED,IAAI,CAAC,YAAY,EAAE;oBACf,YAAY,GAAG,IAAI,CAAC;iBACvB;gBACD,IAAI,CAAC,YAAY,EAAE;oBACf,YAAY,GAAG,IAAI,CAAC;iBACvB;gBAED,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;oBAClC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,uBAAuB;wBAClC,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;oBAClC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,uBAAuB;wBAClC,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,IAAI,YAAY,KAAK,IAAI,EAAE;wBACvB,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,oBAAoB;4BAC/B,YAAY,EACR,oEAAoE;yBAC3E,CAAC;qBACL;oBAED,IAAI,YAAY,KAAK,IAAI,EAAE;wBACvB,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,oBAAoB;4BAC/B,YAAY,EACR,oEAAoE;yBAC3E,CAAC;qBACL;iBACJ;gBAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;gBAC7C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAC5C,UAAU,EACV,OAAO,CACV,CAAC;gBAEF,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,oBAAoB,GACtB,MAAA,cAAc,CAAC,YAAY,mCAAI,IAAI,CAAC;oBACxC,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,EAAE,SAAS,CAAC,EAAE;wBAC1D,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,uEAAuE;yBAC9E,CAAC;qBACL;iBACJ;gBAED,IAAI,OAE4B,CAAC;gBACjC,IAAI,eAAyB,CAAC;gBAC9B,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,eAAe,GAAG,MAAA,cAAc,CAAC,OAAO,mCAAI;wBAC9C,kBAAkB;qBACrB,CAAC;oBACF,MAAM,YAAY,GAAG,OAAO;wBACxB,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,eAAe,CAAC;wBACtC,CAAC,CAAC,EAAE,CAAC;oBACT,MAAM,cAAc,GAAG,OAAO;wBAC1B,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC;wBACtC,CAAC,CAAC,EAAE,CAAC;oBACT,eAAe,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,eAAe,CAAC;oBAC7C,OAAO,iCACH,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EAAE,OAAO,EAChB,eAAe;wBACf,YAAY;wBACZ,cAAc,GACjB,CAAC;iBACL;qBAAM;oBACH,eAAe,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,CAAC,kBAAkB,CAAC,CAAC;oBAClD,OAAO,iCACH,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,eAAe,GACnC,CAAC;iBACL;gBAED,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,MAAM,CAAC,OAAO,EACd,OAAO,CACV,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CACrC,UAAU,EACV,OAAO,EACP,IAAI,EACJ,aAAa,CAAC,YAAY,EAC1B,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,eAAe,CAClB,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,UAAU;oBACtB,OAAO,EAAE,OAAO;iBACnB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;;KACJ;IAED;;;;;;OAMG;IACG,OAAO,CACT,UAAkB,EAClB,OAAe,EACf,MAAe,EACf,SAAoB;;;YAEpB,IAAI;gBACA,MAAM,WAAW,GAAG;oBAChB,qBAAqB,EAAE,UAAU;oBACjC,MAAM;oBACN,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CACpC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CACV,CAAC;gBACF,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;qBACpC,CAAC;iBACL;gBAED,MAAM,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,kBAAkB,CAAC,CAAC;gBACvD,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,WAAW,IAChB,WAAW,KACd,OAAO,EACP,eAAe,EAAE,OAAO,IAE/B,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,WAAW,EAAE,MAAM,CAAC,WAAW;oBAC/B,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,UAAU;oBACV,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,mCAAI,IAAI;oBACzC,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,mCAAI,IAAI;oBACzC,OAAO,EAAE,OAAO;iBACnB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CACT,+DAA+D,EAC/D,GAAG,CACN,CAAC;gBACF,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;;KACJ;IAED;;;;;;OAMG;IACG,QAAQ,CACV,UAAkB,EAClB,OAAsB,EACtB,MAAe,EACf,SAAoB;;YAEpB,IAAI;gBACA,MAAM,WAAW,GAAG;oBAChB,qBAAqB,EAAE,UAAU;oBACjC,MAAM;oBACN,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CACtC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CACV,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,MAAM,eAAe,GACjB,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,WAAW,IAChB,WAAW,KACd,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;;wBAAC,OAAA,iCAC7B,CAAC,KACJ,OAAO,EAAE,MAAA,CAAC,CAAC,OAAO,mCAAI,CAAC,kBAAkB,CAAC,IAC5C,CAAA;qBAAA,CAAC,IAEV,CAAC;gBAEN,IAAI,eAAe,CAAC,OAAO,KAAK,KAAK,EAAE;oBACnC,OAAO,yBAAyB,CAAC,eAAe,CAAC,CAAC;iBACrD;gBAED,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;oBACnC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;iBAChD;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU;oBACtC,KAAK,EAAE,eAAe,CAAC,gBAA4C;iBACtE,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CACT,+DAA+D,EAC/D,GAAG,CACN,CAAC;gBACF,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;QACL,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,SAAS,CACX,eAAuB,EACvB,OAAe,EACf,SAAiB,EACjB,SAAoB;;;YAEpB,IAAI;gBACA,8DAA8D;gBAC9D,gBAAgB;gBAChB,KAAK;gBACL,kCAAkC;gBAClC,eAAe;gBACf,0BAA0B;gBAC1B,uCAAuC;gBACvC,6CAA6C;gBAC7C,SAAS;gBACT,IAAI;gBAEJ,uDAAuD;gBACvD,eAAe;gBACf,0BAA0B;gBAC1B,sCAAsC;gBACtC,wBAAwB;gBACxB,kGAAkG;gBAClG,SAAS;gBACT,IAAI;gBAEJ,yCAAyC;gBACzC,wBAAwB;gBACxB,IAAI;gBAEJ,MAAM,WAAW,GAAyC;oBACtD,qBAAqB,EAAE,eAAe;oBACtC,MAAM,EAAE,SAAS;oBACjB,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;gBAE7C,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,aAAa,EAAE;oBACxC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,kFAAkF;qBACzF,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,SAAS,GAAG,IAAI,CAAC;iBACpB;gBAED,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;gBAE9C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAC5C,UAAU,EACV,OAAO,CACV,CAAC;gBAEF,MAAM,OAAO,GAAG,MAAA,CAAC,cAAc,CAAC,OAAO;oBACnC,CAAC,CAAC,cAAc,CAAC,OAAO;oBACxB,CAAC,CAAC,IAAI,CAAC,mCAAI,CAAC,kBAAkB,CAAC,CAAC;gBACpC,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EACP,eAAe,EAAE,OAAO,IAE/B,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,oBAAoB,GACtB,MAAA,cAAc,CAAC,YAAY,mCAAI,IAAI,CAAC;oBACxC,IACI,SAAS,KAAK,aAAa,CAAC,gBAAgB;wBAC5C,CAAC,sBAAsB,CAAC,oBAAoB,EAAE,SAAS,CAAC,EAC1D;wBACE,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,sEAAsE;yBAC7E,CAAC;qBACL;iBACJ;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAEjE,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU;oBACV,OAAO;iBACV,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;;KACJ;CACJ"}
+{"version":3,"file":"DataRecordsController.js","sourceRoot":"","sources":["DataRecordsController.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAOH,sBAAsB,EACtB,iBAAiB,GACpB,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAQH,yBAAyB,GAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAK9B;;;;OAIG;IACH,YAAY,QAA0B,EAAE,KAAuB;QAC3D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;OAWG;IACG,UAAU,CACZ,qBAA6B,EAC7B,OAAe,EACf,IAAY,EACZ,SAAiB,EACjB,YAAwB,EACxB,YAAwB,EACxB,UAAoB,IAAI,EACxB,YAAsB,IAAI;;;YAE1B,IAAI;gBACA,MAAM,WAAW,GAAyC;oBACtD,qBAAqB;oBACrB,MAAM,EAAE,SAAS;oBACjB,SAAS;iBACZ,CAAC;gBAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC7D,WAAW,CACd,CAAC;gBAEF,yDAAyD;gBACzD,6BAA6B;gBAC7B,6BAA6B;gBAC7B,wBAAwB;gBACxB,yBAAyB;gBACzB,uBAAuB;gBACvB,MAAM;gBAEN,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO,MAAM,CAAC;iBACjB;gBAED,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;gBAE5C,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,aAAa,EAAE;oBACxC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,SAAS,GAAG,IAAI,CAAC;iBACpB;gBAED,IAAI,CAAC,YAAY,EAAE;oBACf,YAAY,GAAG,IAAI,CAAC;iBACvB;gBACD,IAAI,CAAC,YAAY,EAAE;oBACf,YAAY,GAAG,IAAI,CAAC;iBACvB;gBAED,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;oBAClC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,uBAAuB;wBAClC,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;oBAClC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,uBAAuB;wBAClC,YAAY,EACR,qDAAqD;qBAC5D,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,IAAI,YAAY,KAAK,IAAI,EAAE;wBACvB,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,oBAAoB;4BAC/B,YAAY,EACR,oEAAoE;yBAC3E,CAAC;qBACL;oBAED,IAAI,YAAY,KAAK,IAAI,EAAE;wBACvB,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,oBAAoB;4BAC/B,YAAY,EACR,oEAAoE;yBAC3E,CAAC;qBACL;iBACJ;gBAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;gBAC7C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAC5C,UAAU,EACV,OAAO,CACV,CAAC;gBAEF,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,oBAAoB,GACtB,MAAA,cAAc,CAAC,YAAY,mCAAI,IAAI,CAAC;oBACxC,IAAI,CAAC,sBAAsB,CAAC,oBAAoB,EAAE,SAAS,CAAC,EAAE;wBAC1D,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,uEAAuE;yBAC9E,CAAC;qBACL;iBACJ;gBAED,IAAI,OAE4B,CAAC;gBACjC,IAAI,eAAyB,CAAC;gBAC9B,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,eAAe,GAAG,MAAA,cAAc,CAAC,OAAO,mCAAI;wBAC9C,kBAAkB;qBACrB,CAAC;oBACF,MAAM,YAAY,GAAG,OAAO;wBACxB,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,eAAe,CAAC;wBACtC,CAAC,CAAC,EAAE,CAAC;oBACT,MAAM,cAAc,GAAG,OAAO;wBAC1B,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,OAAO,CAAC;wBACtC,CAAC,CAAC,EAAE,CAAC;oBACT,eAAe,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,eAAe,CAAC;oBAC7C,OAAO,iCACH,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EAAE,OAAO,EAChB,eAAe;wBACf,YAAY;wBACZ,cAAc,GACjB,CAAC;iBACL;qBAAM;oBACH,eAAe,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,CAAC,kBAAkB,CAAC,CAAC;oBAClD,OAAO,iCACH,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EAAE,OAAO,EAChB,eAAe,EAAE,eAAe,GACnC,CAAC;iBACL;gBAED,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,MAAM,CAAC,OAAO,EACd,OAAO,CACV,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CACrC,UAAU,EACV,OAAO,EACP,IAAI,EACJ,aAAa,CAAC,YAAY,EAC1B,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,eAAe,CAClB,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,UAAU;oBACtB,OAAO,EAAE,OAAO;iBACnB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;;KACJ;IAED;;;;;;OAMG;IACG,OAAO,CACT,UAAkB,EAClB,OAAe,EACf,MAAe,EACf,SAAoB;;;YAEpB,IAAI;gBACA,MAAM,WAAW,GAAG;oBAChB,qBAAqB,EAAE,UAAU;oBACjC,MAAM;oBACN,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CACpC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CACV,CAAC;gBACF,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;qBACpC,CAAC;iBACL;gBAED,MAAM,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,CAAC,kBAAkB,CAAC,CAAC;gBACvD,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,WAAW,IAChB,WAAW,KACd,OAAO,EACP,eAAe,EAAE,OAAO,IAE/B,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,WAAW,EAAE,MAAM,CAAC,WAAW;oBAC/B,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,UAAU;oBACV,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,mCAAI,IAAI;oBACzC,YAAY,EAAE,MAAA,MAAM,CAAC,YAAY,mCAAI,IAAI;oBACzC,OAAO,EAAE,OAAO;iBACnB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CACT,+DAA+D,EAC/D,GAAG,CACN,CAAC;gBACF,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;;KACJ;IAED;;;;;;OAMG;IACG,QAAQ,CACV,UAAkB,EAClB,OAAsB,EACtB,MAAe,EACf,SAAoB;;YAEpB,IAAI;gBACA,MAAM,WAAW,GAAG;oBAChB,qBAAqB,EAAE,UAAU;oBACjC,MAAM;oBACN,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CACtC,OAAO,CAAC,OAAO,CAAC,UAAU,EAC1B,OAAO,CACV,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,MAAM,eAAe,GACjB,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,WAAW,IAChB,WAAW,KACd,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;;wBAAC,OAAA,iCAC7B,CAAC,KACJ,OAAO,EAAE,MAAA,CAAC,CAAC,OAAO,mCAAI,CAAC,kBAAkB,CAAC,IAC5C,CAAA;qBAAA,CAAC,IAEV,CAAC;gBAEN,IAAI,eAAe,CAAC,OAAO,KAAK,KAAK,EAAE;oBACnC,OAAO,yBAAyB,CAAC,eAAe,CAAC,CAAC;iBACrD;gBAED,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE;oBACnC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;iBAChD;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU;oBACtC,KAAK,EAAE,eAAe,CAAC,gBAA4C;iBACtE,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,CAAC,KAAK,CACT,+DAA+D,EAC/D,GAAG,CACN,CAAC;gBACF,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,0BAA0B;iBAC3C,CAAC;aACL;QACL,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,SAAS,CACX,eAAuB,EACvB,OAAe,EACf,SAAiB,EACjB,SAAoB;;;YAEpB,IAAI;gBACA,8DAA8D;gBAC9D,gBAAgB;gBAChB,KAAK;gBACL,kCAAkC;gBAClC,eAAe;gBACf,0BAA0B;gBAC1B,uCAAuC;gBACvC,6CAA6C;gBAC7C,SAAS;gBACT,IAAI;gBAEJ,uDAAuD;gBACvD,eAAe;gBACf,0BAA0B;gBAC1B,sCAAsC;gBACtC,wBAAwB;gBACxB,kGAAkG;gBAClG,SAAS;gBACT,IAAI;gBAEJ,yCAAyC;gBACzC,wBAAwB;gBACxB,IAAI;gBAEJ,MAAM,WAAW,GAAyC;oBACtD,qBAAqB,EAAE,eAAe;oBACtC,MAAM,EAAE,SAAS;oBACjB,SAAS;iBACZ,CAAC;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAC9D,WAAW,CACd,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO,OAAO,CAAC;iBAClB;gBAED,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;gBAE7C,IAAI,CAAC,SAAS,IAAI,MAAM,KAAK,aAAa,EAAE;oBACxC,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,eAAe;wBAC1B,YAAY,EACR,kFAAkF;qBACzF,CAAC;iBACL;gBAED,IAAI,MAAM,KAAK,aAAa,EAAE;oBAC1B,SAAS,GAAG,IAAI,CAAC;iBACpB;gBAED,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;gBAE9C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAC5C,UAAU,EACV,OAAO,CACV,CAAC;gBAEF,MAAM,OAAO,GAAG,MAAA,CAAC,cAAc,CAAC,OAAO;oBACnC,CAAC,CAAC,cAAc,CAAC,OAAO;oBACxB,CAAC,CAAC,IAAI,CAAC,mCAAI,CAAC,kBAAkB,CAAC,CAAC;gBACpC,MAAM,aAAa,GACf,MAAM,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAC7C,OAAO,CAAC,OAAO,gCAEX,MAAM,EAAE,aAAa,IAClB,WAAW,KACd,OAAO,EACP,eAAe,EAAE,OAAO,IAE/B,CAAC;gBAEN,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,yBAAyB,CAAC,aAAa,CAAC,CAAC;iBACnD;gBAED,IAAI,cAAc,CAAC,OAAO,EAAE;oBACxB,MAAM,oBAAoB,GACtB,MAAA,cAAc,CAAC,YAAY,mCAAI,IAAI,CAAC;oBACxC,IACI,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,aAAa;wBAC3C,SAAS,KAAK,aAAa,CAAC,gBAAgB;wBAC5C,CAAC,sBAAsB,CAAC,oBAAoB,EAAE,SAAS,CAAC,EAC1D;wBACE,OAAO;4BACH,OAAO,EAAE,KAAK;4BACd,SAAS,EAAE,gBAAgB;4BAC3B,YAAY,EACR,sEAAsE;yBAC7E,CAAC;qBACL;iBACJ;gBAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAEjE,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU;oBACV,OAAO;iBACV,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;;KACJ;CACJ"}

package/EventRecordsController.d.ts

@@ -37,21 +37,76 @@ export declare class EventRecordsController {
      */
     updateEvent(request: UpdateEventRecordRequest): Promise<UpdateEventRecordResult>;
 }
+/**
+ * Defines the possible results of a "add event count" request.
+ *
+ * @dochash types/records/events
+ * @doctitle Event Types
+ * @docsidebar Events
+ * @docdescription Event records are useful for keeping track of how many times an event has occurred.
+ * @docgroup 01-add
+ * @docorder 0
+ * @docname AddCountResult
+ */
 export type AddCountResult = AddCountSuccess | AddCountFailure;
+/**
+ * Defines an interface that represents a successful "add event count" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 02-add
+ * @docorder 1
+ * @docname AddCountSuccess
+ */
 export interface AddCountSuccess {
     success: true;
+    /**
+     * The name of the record.
+     */
     recordName: string;
+    /**
+     * The name of the event that the count was added to.
+     */
     eventName: string;
+    /**
+     * The number of events that were added.
+     */
     countAdded: number;
 }
+/**
+ * Defines an interface that represents a failed "add event count" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 01-add
+ * @docorder 2
+ * @docname AddCountFailure
+ */
 export interface AddCountFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | NotLoggedInError | ValidatePublicRecordKeyFailure['errorCode'] | AddEventCountStoreFailure['errorCode'] | AuthorizeDenied['errorCode'] | 'not_supported';
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
+/**
+ * Defines the possible results of a "get event count" request.
+ *
+ * @dochash types/records/events
+ * @docgroup 02-count
+ * @docorder 0
+ * @docname GetCountResult
+ */
 export type GetCountResult = GetCountSuccess | GetCountFailure;
 /**
- * Defines an interface that represents a successful "get data" result.
+ * Defines an interface that represents a successful "get event count" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 02-count
+ * @docorder 1
+ * @docname GetCountSuccess
  */
 export interface GetCountSuccess {
     success: true;
@@ -72,11 +127,33 @@ export interface GetCountSuccess {
      */
     markers: string[];
 }
+/**
+ * Defines an interface that represents a failed "get event count" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 02-count
+ * @docorder 2
+ * @docname GetCountFailure
+ */
 export interface GetCountFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | GetEventCountStoreFailure['errorCode'] | AuthorizeDenied['errorCode'] | 'not_supported';
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
+/**
+ * Defines an interface that represents a request to update an event.
+ *
+ * @dochash types/records/events
+ * @docgroup 03-update
+ * @docorder 0
+ * @docname UpdateEventRecordRequest
+ */
 export interface UpdateEventRecordRequest {
     /**
      * The record key or the name of the record that should be updated.
@@ -106,10 +183,34 @@ export interface UpdateEventRecordRequest {
      */
     instances?: string[];
 }
+/**
+ * Defines the possible results of an "update event" request.
+ *
+ * @dochash types/records/events
+ * @docgroup 03-update
+ * @docorder 1
+ * @docname UpdateEventRecordResult
+ */
 export type UpdateEventRecordResult = UpdateEventRecordSuccess | UpdateEventRecordFailure;
+/**
+ * Defines an interface that represents a successful "update event" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 03-update
+ * @docorder 2
+ * @docname UpdateEventRecordSuccess
+ */
 export interface UpdateEventRecordSuccess {
     success: true;
 }
+/**
+ * Defines an interface that represents a failed "update event" result.
+ *
+ * @dochash types/records/events
+ * @docgroup 03-update
+ * @docorder 3
+ * @docname UpdateEventRecordFailure
+ */
 export interface UpdateEventRecordFailure {
     success: false;
     errorCode: ServerError | AuthorizeDenied['errorCode'] | ValidatePublicRecordKeyFailure['errorCode'];

package/FileRecordsController.d.ts

@@ -40,6 +40,14 @@ export declare class FileRecordsController {
 }
 /**
  * Defines an interface that is used for requests to record a file.
+ *
+ * @dochash types/records/files
+ * @doctitle File Types
+ * @docsidebar Files
+ * @docdescription File records are used to store large blobs of data.
+ * @docgroup 01-create
+ * @docorder 0
+ * @docname RecordFileRequest
  */
 export interface RecordFileRequest {
     /**
@@ -73,7 +81,13 @@ export interface RecordFileRequest {
      */
     instances?: string[];
 }
+/**
+ * Defines the possible results of a request to record a file.
+ */
 export type RecordFileResult = RecordFileSuccess | RecordFileFailure;
+/**
+ * Defines an interface that represents a successful request to record a file.
+ */
 export interface RecordFileSuccess {
     success: true;
     /**
@@ -99,26 +113,74 @@ export interface RecordFileSuccess {
      */
     markers: string[];
 }
+/**
+ * Defines an interface that represents a failed request to record a file.
+ */
 export interface RecordFileFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | NotLoggedInError | ValidatePublicRecordKeyFailure['errorCode'] | AddFileFailure['errorCode'] | AuthorizeDenied['errorCode'] | 'invalid_file_data' | 'not_supported';
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
     /**
      * The URL that the file is available at if it has already been uploaded.
      */
     existingFileUrl?: string;
 }
+/**
+ * Defines the possible results of a request to erase a file record.
+ *
+ * @dochash types/records/files
+ * @docgroup 02-erase
+ * @docorder 0
+ * @docname EraseFileResult
+ */
 export type EraseFileResult = EraseFileSuccess | EraseFileFailure;
+/**
+ * Defines an interface that represents a successful request to erase a file record.
+ *
+ * @dochash types/records/files
+ * @docgroup 02-erase
+ * @docorder 1
+ * @docname EraseFileSuccess
+ */
 export interface EraseFileSuccess {
     success: true;
+    /**
+     * The name of the record that the file was erased from.
+     */
     recordName: string;
+    /**
+     * The name of the file that was erased.
+     */
     fileName: string;
 }
+/**
+ * Defines an interface that represents a failed request to erase a file record.
+ *
+ * @dochash types/records/files
+ * @docgroup 02-erase
+ * @docorder 2
+ * @docname EraseFileFailure
+ */
 export interface EraseFileFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | EraseFileStoreResult['errorCode'] | NotLoggedInError | AuthorizeDenied['errorCode'] | ValidatePublicRecordKeyFailure['errorCode'];
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
+/**
+ * Defines the possible results of a request to mark a file record as uploaded.
+ */
 export type FileUploadedResult = FileUploadedSuccess | FileUploadedFailure;
 export interface FileUploadedSuccess {
     success: true;
@@ -128,6 +190,9 @@ export interface FileUploadedFailure {
     errorCode: ServerError | MarkFileRecordAsUploadedFailure['errorCode'];
     errorMessage: string;
 }
+/**
+ * Defines the possible results of a request to read a file record.
+ */
 export type ReadFileResult = ReadFileSuccess | ReadFileFailure;
 export interface ReadFileSuccess {
     success: true;

package/PolicyController.d.ts

@@ -52,7 +52,7 @@ export declare class PolicyController {
      * Attempts to grant a permission to a marker.
      * @param request The request for the operation.
      */
-    grantMarkerPermission(request: GrantMarkerPermissionRequest): Promise<GrantMarkerPermissionResponse>;
+    grantMarkerPermission(request: GrantMarkerPermissionRequest): Promise<GrantMarkerPermissionResult>;
     /**
      * Attempts to revoke a permission from a marker.
      * @param request The request for the operation.
@@ -672,13 +672,46 @@ export interface GrantMarkerPermissionRequest {
     permission: AvailablePermissions;
     instances?: string[] | null;
 }
-export type GrantMarkerPermissionResponse = GrantMarkerPermissionSuccess | GrantMarkerPermissionFailure;
+/**
+ * Defines the possible results of revoking a marker permission from a policy.
+ *
+ * @dochash types/records/policies
+ * @doctitle Policy Types
+ * @docsidebar Policies
+ * @docdescription Types for working with policies.
+ * @docgroup 01-grant
+ * @docorder 0
+ * @docname GrantMarkerPermissionResult
+ */
+export type GrantMarkerPermissionResult = GrantMarkerPermissionSuccess | GrantMarkerPermissionFailure;
+/**
+ * Defines an interface that represents a successful request to grant a marker permission to a policy.
+ *
+ * @dochash types/records/policies
+ * @docgroup 01-grant
+ * @docorder 1
+ * @docname GrantMarkerPermissionSuccess
+ */
 export interface GrantMarkerPermissionSuccess {
     success: true;
 }
+/**
+ * Defines an interface that represents a failed request to grant a marker permission to a policy.
+ *
+ * @dochash types/records/policies
+ * @docgroup 01-grant
+ * @docorder 2
+ * @docname GrantMarkerPermissionFailure
+ */
 export interface GrantMarkerPermissionFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | AuthorizeDenied['errorCode'] | UpdateUserPolicyFailure['errorCode'];
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
 export interface RevokeMarkerPermissionRequest {
@@ -688,13 +721,43 @@ export interface RevokeMarkerPermissionRequest {
     permission: AvailablePermissions;
     instances?: string[] | null;
 }
+/**
+ * Defines the possible results of revoking a marker permission from a policy.
+ *
+ * @dochash types/records/policies
+ * @docgroup 02-revoke
+ * @docorder 0
+ * @docname RevokeMarkerPermissionResult
+ */
 export type RevokeMarkerPermissionResult = RevokeMarkerPermissionSuccess | RevokeMarkerPermissionFailure;
+/**
+ * Defines an interface that represents a successful request to revoke a marker permission from a policy.
+ *
+ * @dochash types/records/policies
+ * @docgroup 02-revoke
+ * @docorder 1
+ * @docname RevokeMarkerPermissionSuccess
+ */
 export interface RevokeMarkerPermissionSuccess {
     success: true;
 }
+/**
+ * Defines an interface that represents a failed request to revoke a marker permission from a policy.
+ *
+ * @dochash types/records/policies
+ * @docgroup 02-revoke
+ * @docorder 2
+ * @docname RevokeMarkerPermissionFailure
+ */
 export interface RevokeMarkerPermissionFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | AuthorizeDenied['errorCode'] | GetUserPolicyFailure['errorCode'] | UpdateUserPolicyFailure['errorCode'];
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
 export type ReadUserPolicyResult = ReadUserPolicySuccess | ReadUserPolicyFailure;
@@ -776,13 +839,46 @@ export interface GrantRoleRequest {
     role: string;
     expireTimeMs?: number | null;
 }
+/**
+ * Defines the possible results of granting a role.
+ *
+ * @dochash types/records/roles
+ * @doctitle Role Types
+ * @docsidebar Roles
+ * @docdescription Types for working with roles.
+ * @docgroup 01-grant
+ * @docorder 0
+ * @docname GrantRoleResult
+ */
 export type GrantRoleResult = GrantRoleSuccess | GrantRoleFailure;
+/**
+ * Defines an interface that represents a successful request to grant a role.
+ *
+ * @dochash types/records/roles
+ * @docgroup 01-grant
+ * @docorder 1
+ * @docname GrantRoleSuccess
+ */
 export interface GrantRoleSuccess {
     success: true;
 }
+/**
+ * Defines an interface that represents a failed request to grant a role.
+ *
+ * @dochash types/records/roles
+ * @docgroup 01-grant
+ * @docorder 2
+ * @docname GrantRoleFailure
+ */
 export interface GrantRoleFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | AuthorizeDenied['errorCode'] | UpdateUserRolesFailure['errorCode'];
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
 export interface RevokeRoleRequest {
@@ -790,13 +886,43 @@ export interface RevokeRoleRequest {
     instance?: string;
     role: string;
 }
+/**
+ * Defines the possible results of revoking a role.
+ *
+ * @dochash types/records/roles
+ * @docgroup 01-revoke
+ * @docorder 0
+ * @docname RevokeRoleResult
+ */
 export type RevokeRoleResult = RevokeRoleSuccess | RevokeRoleFailure;
+/**
+ * Defines an interface that represents a successful request to revoke a role.
+ *
+ * @dochash types/records/roles
+ * @docgroup 01-revoke
+ * @docorder 1
+ * @docname RevokeRoleSuccess
+ */
 export interface RevokeRoleSuccess {
     success: true;
 }
+/**
+ * Defines an interface that represents a failed request to revoke a role.
+ *
+ * @dochash types/records/roles
+ * @docgroup 01-revoke
+ * @docorder 2
+ * @docname RevokeRoleFailure
+ */
 export interface RevokeRoleFailure {
     success: false;
+    /**
+     * The error code that indicates why the request failed.
+     */
     errorCode: ServerError | AuthorizeDenied['errorCode'] | UpdateUserRolesFailure['errorCode'];
+    /**
+     * The error message that indicates why the request failed.
+     */
     errorMessage: string;
 }
 export {};

package/PolicyController.js

@@ -84,7 +84,7 @@ export class PolicyController {
                 }
             }
             else {
-                const result = yield this._records.validateRecordName(request.recordKeyOrRecordName);
+                const result = yield this._records.validateRecordName(request.recordKeyOrRecordName, request.userId);
                 if (result.success === false) {
                     return {
                         success: false,