@fairandsmart/consents-ce 2.0.6 → 2.0.8

package/README.md

@@ -2,6 +2,11 @@
 
 This project implements TypeScript definitions and API helpers for the [Fair&Smart Right Consents API](https://cmback.dev.env.fairandsmart.tech/swagger-ui/). It's meant for use in [Right Consents Front-end](https://github.com/fairandsmart/consent-manager-lib-ce), but should be general enough to use in any project. The code is maintained and based on the [Right Consents Back-end](https://github.com/fairandsmart/consent-manager-back) API resources and models, to be as close as possible to the true representation of the resources.
 
+# NPM/Node version
+
+Known to work using node v14.21.3 (npm v6.14.18).
+Use NVM to force version if needed.
+
 # Install
 
 ```

package/consents/interfaces.d.ts

@@ -3,6 +3,7 @@ export declare enum Confirmation {
     NONE = "NONE",
     FORM_CODE = "FORM_CODE",
     EMAIL_CODE = "EMAIL_CODE",
+    MAGIC_LINK = "MAGIC_LINK",
     SMS_CODE = "SMS_CODE",
     SIGNATURE = "SIGNATURE",
     AUDIO_RECORD = "AUDIO_RECORD",
@@ -75,6 +76,8 @@ export interface ConsentContext {
     notification?: string;
     /** Whether to send an invitation email upon transaction creation */
     sendInvitation?: boolean;
+    /** used to tell where consent can be managed if needed */
+    managementUrl?: string;
 }
 export interface ConsentTransaction {
     id: string;

package/consents/interfaces.js

@@ -10,6 +10,7 @@ var Confirmation;
   Confirmation["NONE"] = "NONE";
   Confirmation["FORM_CODE"] = "FORM_CODE";
   Confirmation["EMAIL_CODE"] = "EMAIL_CODE";
+  Confirmation["MAGIC_LINK"] = "MAGIC_LINK";
   Confirmation["SMS_CODE"] = "SMS_CODE";
   Confirmation["SIGNATURE"] = "SIGNATURE";
   Confirmation["AUDIO_RECORD"] = "AUDIO_RECORD";
@@ -23,7 +24,7 @@ var SubjectInfosKeys;
   SubjectInfosKeys["PHONE_KEY"] = "phoneNumber";
 })(
   (SubjectInfosKeys =
-    exports.SubjectInfosKeys || (exports.SubjectInfosKeys = {}))
+    exports.SubjectInfosKeys || (exports.SubjectInfosKeys = {})),
 );
 var ConfirmationConfigKeys;
 (function (ConfirmationConfigKeys) {
@@ -31,5 +32,5 @@ var ConfirmationConfigKeys;
   ConfirmationConfigKeys["SENDER_PHONE_KEY"] = "senderPhone";
 })(
   (ConfirmationConfigKeys =
-    exports.ConfirmationConfigKeys || (exports.ConfirmationConfigKeys = {}))
+    exports.ConfirmationConfigKeys || (exports.ConfirmationConfigKeys = {})),
 );

package/forms/consent-collector.js

@@ -70,7 +70,7 @@ var ConsentCollector = /** @class */ (function () {
       var newWindow = window.open(
         location,
         "com_fs_window_consentCollect",
-        "menubar=no,location=no,resizable=yes,scrollbars=yes,status=no,width=900px,height=600px"
+        "menubar=no,location=no,resizable=yes,scrollbars=yes,status=no,width=900px,height=600px",
       );
       if (!newWindow) {
         throw new Error("Could not open window");
@@ -107,7 +107,7 @@ var ConsentCollector = /** @class */ (function () {
             resolve();
           },
         },
-        el
+        el,
       );
     });
   };

package/index.d.ts

@@ -2,9 +2,10 @@ export * from './http';
 export * from './common';
 export { RightConsents } from './api';
 export * as ConsentsResource from './consents';
-export * as ModelsResource from './models';
+export * as FormResource from './forms';
 export * as KeysResource from './keys';
-export * as ReceiptsResource from './receipts';
+export * as ModelsResource from './models';
+export * as PeerResources from './peers';
 export * as RecordsResource from './records';
 export * as StatsResource from './statistics';
 export * as SubjectsResource from './subjects';
@@ -12,4 +13,4 @@ export * as SystemResource from './system';
 export * as TokensResource from './tokens';
 export * as UsersResource from './users';
 export { ConsentCollector } from './forms';
-export declare const version = "v1.4.4 (ce)";
+export declare const version = "v2.0.8 (ce)";

package/index.js

@@ -26,15 +26,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = exports.ConsentCollector = exports.UsersResource = exports.TokensResource = exports.SystemResource = exports.SubjectsResource = exports.StatsResource = exports.RecordsResource = exports.ReceiptsResource = exports.KeysResource = exports.ModelsResource = exports.ConsentsResource = exports.RightConsents = void 0;
+exports.version = exports.ConsentCollector = exports.UsersResource = exports.TokensResource = exports.SystemResource = exports.SubjectsResource = exports.StatsResource = exports.RecordsResource = exports.PeerResources = exports.ModelsResource = exports.KeysResource = exports.FormResource = exports.ConsentsResource = exports.RightConsents = void 0;
 __exportStar(require("./http"), exports);
 __exportStar(require("./common"), exports);
 var api_1 = require("./api");
 Object.defineProperty(exports, "RightConsents", { enumerable: true, get: function () { return api_1.RightConsents; } });
 exports.ConsentsResource = __importStar(require("./consents"));
-exports.ModelsResource = __importStar(require("./models"));
+exports.FormResource = __importStar(require("./forms"));
 exports.KeysResource = __importStar(require("./keys"));
-exports.ReceiptsResource = __importStar(require("./receipts"));
+exports.ModelsResource = __importStar(require("./models"));
+exports.PeerResources = __importStar(require("./peers"));
 exports.RecordsResource = __importStar(require("./records"));
 exports.StatsResource = __importStar(require("./statistics"));
 exports.SubjectsResource = __importStar(require("./subjects"));
@@ -43,4 +44,4 @@ exports.TokensResource = __importStar(require("./tokens"));
 exports.UsersResource = __importStar(require("./users"));
 var forms_1 = require("./forms");
 Object.defineProperty(exports, "ConsentCollector", { enumerable: true, get: function () { return forms_1.ConsentCollector; } });
-exports.version = "v1.4.4 (ce)";
+exports.version = "v2.0.8 (ce)";

package/models/interfaces.js

@@ -32,7 +32,7 @@ var ModelEntryStatus;
   ModelEntryStatus["DELETED"] = "DELETED";
 })(
   (ModelEntryStatus =
-    exports.ModelEntryStatus || (exports.ModelEntryStatus = {}))
+    exports.ModelEntryStatus || (exports.ModelEntryStatus = {})),
 );
 exports.MODEL_ENTRY_STATUSES = Object.keys(ModelEntryStatus);
 var ModelVersionStatus;
@@ -42,7 +42,7 @@ var ModelVersionStatus;
   ModelVersionStatus["ARCHIVED"] = "ARCHIVED";
 })(
   (ModelVersionStatus =
-    exports.ModelVersionStatus || (exports.ModelVersionStatus = {}))
+    exports.ModelVersionStatus || (exports.ModelVersionStatus = {})),
 );
 var ModelVersionType;
 (function (ModelVersionType) {
@@ -50,7 +50,7 @@ var ModelVersionType;
   ModelVersionType["MINOR"] = "MINOR";
 })(
   (ModelVersionType =
-    exports.ModelVersionType || (exports.ModelVersionType = {}))
+    exports.ModelVersionType || (exports.ModelVersionType = {})),
 );
 var Visibility;
 (function (Visibility) {
@@ -83,7 +83,7 @@ var ProcessingPurpose;
   ProcessingPurpose["CONSENT_RESEARCH"] = "CONSENT_RESEARCH";
 })(
   (ProcessingPurpose =
-    exports.ProcessingPurpose || (exports.ProcessingPurpose = {}))
+    exports.ProcessingPurpose || (exports.ProcessingPurpose = {})),
 );
 exports.PROCESSING_PURPOSES = Object.keys(ProcessingPurpose);
 var ProcessingLegalBasis;
@@ -100,7 +100,7 @@ var ProcessingLegalBasis;
     "LEGAL_BASIS_VITAL_INTEREST";
 })(
   (ProcessingLegalBasis =
-    exports.ProcessingLegalBasis || (exports.ProcessingLegalBasis = {}))
+    exports.ProcessingLegalBasis || (exports.ProcessingLegalBasis = {})),
 );
 exports.PROCESSING_LEGAL_BASES = Object.keys(ProcessingLegalBasis);
 var PreferenceValueType;
@@ -113,7 +113,7 @@ var PreferenceValueType;
   PreferenceValueType["FREE_TEXT"] = "FREE_TEXT";
 })(
   (PreferenceValueType =
-    exports.PreferenceValueType || (exports.PreferenceValueType = {}))
+    exports.PreferenceValueType || (exports.PreferenceValueType = {})),
 );
 exports.PREFERENCE_VALUE_TYPES = Object.keys(PreferenceValueType);
 var LogoPosition;
@@ -129,7 +129,7 @@ var FormLayoutOrientation;
   FormLayoutOrientation["VERTICAL"] = "VERTICAL";
 })(
   (FormLayoutOrientation =
-    exports.FormLayoutOrientation || (exports.FormLayoutOrientation = {}))
+    exports.FormLayoutOrientation || (exports.FormLayoutOrientation = {})),
 );
 exports.CONSENT_FORM_ORIENTATIONS = Object.keys(FormLayoutOrientation);
 var ConsentOrigin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fairandsmart/consents-ce",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "TypeScript mappings for the Fair&Smart's Right Consents Community features",
   "sideEffects": false,
   "scripts": {},

package/records/interfaces.js

@@ -34,7 +34,7 @@ var RecordStatusExplanation;
   RecordStatusExplanation["ENTRY_DELETED"] = "ENTRY_DELETED";
 })(
   (RecordStatusExplanation =
-    exports.RecordStatusExplanation || (exports.RecordStatusExplanation = {}))
+    exports.RecordStatusExplanation || (exports.RecordStatusExplanation = {})),
 );
 exports.RECORD_IDENTIFIER_DEFAULT = "undefined";
 exports.RECORD_IDENTIFIER_SEPARATOR = "|";
@@ -44,7 +44,8 @@ var ExtractionConfigOperator;
   ExtractionConfigOperator["OR"] = "OR";
 })(
   (ExtractionConfigOperator =
-    exports.ExtractionConfigOperator || (exports.ExtractionConfigOperator = {}))
+    exports.ExtractionConfigOperator ||
+    (exports.ExtractionConfigOperator = {})),
 );
 var NotificationReportStatus;
 (function (NotificationReportStatus) {
@@ -58,7 +59,8 @@ var NotificationReportStatus;
   NotificationReportStatus["NONE"] = "NONE";
 })(
   (NotificationReportStatus =
-    exports.NotificationReportStatus || (exports.NotificationReportStatus = {}))
+    exports.NotificationReportStatus ||
+    (exports.NotificationReportStatus = {})),
 );
 var NotificationReportType;
 (function (NotificationReportType) {
@@ -69,5 +71,5 @@ var NotificationReportType;
   NotificationReportType["NONE"] = "NONE";
 })(
   (NotificationReportType =
-    exports.NotificationReportType || (exports.NotificationReportType = {}))
+    exports.NotificationReportType || (exports.NotificationReportType = {})),
 );

package/webhooks/api.d.ts

@@ -0,0 +1,8 @@
+import { Observable } from 'rxjs';
+import { WebhookDto } from './interfaces';
+import { RCApiOptions } from '../http';
+export declare function listWebhooks(options?: RCApiOptions): Observable<WebhookDto>;
+export declare function createWebhook(webhook: WebhookDto, options?: RCApiOptions): Observable<WebhookDto>;
+export declare function getWebhook(webhookid: string, options?: RCApiOptions): Observable<WebhookDto>;
+export declare function updateWebhook(webhookid: string, webhook: WebhookDto, options?: RCApiOptions): Observable<WebhookDto>;
+export declare function deleteWebhook(webhookid: string, options?: RCApiOptions): Observable<WebhookDto>;

package/webhooks/api.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteWebhook =
+  exports.updateWebhook =
+  exports.getWebhook =
+  exports.createWebhook =
+  exports.listWebhooks =
+    void 0;
+var api_1 = require("../api");
+function listWebhooks(options) {
+  return api_1.RightConsents.http({
+    method: "GET",
+    url: "".concat(api_1.RightConsents.config.apiRoot, "/webhooks"),
+    options: options,
+  });
+}
+exports.listWebhooks = listWebhooks;
+function createWebhook(webhook, options) {
+  return api_1.RightConsents.http({
+    method: "POST",
+    url: "".concat(api_1.RightConsents.config.apiRoot, "/webhooks"),
+    body: webhook,
+    resolveHeaders: true,
+    headers: {
+      "Content-Type": "application/json",
+    },
+    options: options,
+  });
+}
+exports.createWebhook = createWebhook;
+function getWebhook(webhookid, options) {
+  return api_1.RightConsents.http({
+    method: "GET",
+    url: ""
+      .concat(api_1.RightConsents.config.apiRoot, "/webhooks/")
+      .concat(webhookid),
+    options: options,
+  });
+}
+exports.getWebhook = getWebhook;
+function updateWebhook(webhookid, webhook, options) {
+  return api_1.RightConsents.http({
+    method: "PUT",
+    url: ""
+      .concat(api_1.RightConsents.config.apiRoot, "/webhooks/")
+      .concat(webhookid),
+    body: webhook,
+    options: options,
+  });
+}
+exports.updateWebhook = updateWebhook;
+function deleteWebhook(webhookid, options) {
+  return api_1.RightConsents.http({
+    method: "DELETE",
+    url: ""
+      .concat(api_1.RightConsents.config.apiRoot, "/webhooks/")
+      .concat(webhookid),
+    options: options,
+  });
+}
+exports.deleteWebhook = deleteWebhook;

package/webhooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './api';

package/webhooks/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = 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];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./api"), exports);

package/webhooks/interfaces.d.ts

@@ -0,0 +1,22 @@
+export interface WebhookDto {
+    id?: string;
+    name: string;
+    targetUrl: string;
+    subscribedActions: SubscribedActions[];
+    delivery?: WebhookDeliveryDto[];
+}
+export declare enum SubscribedActions {
+    CONSENT_COMMIT = "CONSENT_COMMIT"
+}
+export interface WebhookDeliveryDto {
+    id?: string;
+    sourceId: string;
+    webhookId: string;
+    redelivery: boolean;
+    createdAt: string;
+    deliveredAt: string;
+    duration: string;
+    status: string;
+    statusCode: number;
+    action: SubscribedActions;
+}

package/webhooks/interfaces.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscribedActions = void 0;
+var SubscribedActions;
+(function (SubscribedActions) {
+  SubscribedActions["CONSENT_COMMIT"] = "CONSENT_COMMIT";
+})(
+  (SubscribedActions =
+    exports.SubscribedActions || (exports.SubscribedActions = {})),
+);