@dev-crew-berlin/enter-js-utils 0.47.4 → 0.49.0

package/README.md

@@ -25,20 +25,29 @@ typed js client for the enter api.
 ```typescript
 import EnterAPIClient from '@dev-crew-berlin/enter-js-utils/api-client'
 
-const url = 'https://api.enter.events'
 
 async function apiExample() {
   // fetch access Token
-  const accessToken = await EnterAPIClient.fetchAccessToken({
-    url: url,
-    user: 'me',
-    password: 'xxx',
-    deviceName: 'my-device',
+  const accessTokenResult = await EnterAPIClient.fetchAccessToken({
+    oidc: {
+      url: 'https://auth.enter.events',
+      projectId: '246359835166114187'
+    }
+    user: {
+      userId: '',
+      keyId: '',
+      key: ''
+    }
   })
+  if (!accessTokenResult.success) {
+    throw new Error(accessTokenResult.error)
+  }
+
+  const accessToken = accessTokenResult.data.accessToken
 
   // create api instance
   const api = new EnterAPIClient({
-    credentials: { accessToken, url },
+    credentials: { accessToken, url: 'https://api.enter.events' },
     onLogout: (reason?: string) => {
       deleteCredetials()
     },

package/dist/api-client/api-base.d.ts

@@ -1,4 +1,4 @@
-import { APIResult } from '../lib';
+import { APIResult, Result } from '../lib';
 import { paths } from '../generated/api-schema';
 export interface APICredentials {
     accessToken: string;
@@ -30,6 +30,20 @@ export default class APIBase {
         onLogout: (reason?: string) => void;
     });
     private static fetchResult;
+    static fetchAccessToken(args: {
+        oidc: {
+            url: string;
+            projectId: string;
+        };
+        user: {
+            userId: string;
+            keyId: string;
+            key: string;
+        };
+    }): Promise<Result<string, {
+        accessToken: string;
+        expires: Date;
+    }>>;
     private fetchFromEnter;
     protected get<Path extends keyof paths>(endpoint: Path): Promise<APIResult<ResponseType<Path, 'get'>>>;
     protected post<Path extends keyof paths>(endpoint: Path, data: RequestBody<Path, 'post'>): Promise<APIResult<ResponseType<Path, 'post'>>>;

package/dist/api-client/api-base.js

@@ -1,3 +1,4 @@
+import jws from 'jws';
 import { failure, success } from '../lib';
 export default class APIBase {
   constructor(args) {
@@ -15,6 +16,58 @@ export default class APIBase {
       return failure(e);
     }
   }
+  static async fetchAccessToken(args) {
+    // see https://zitadel.com/docs/guides/integrate/private-key-jwt to learn about this flow
+    const {
+      oidc,
+      user
+    } = args;
+    const timestampNow = new Date().getTime() / 1000;
+    const assertionToken = jws.sign({
+      header: {
+        alg: 'RS256',
+        kid: user.keyId
+      },
+      payload: {
+        iss: user.userId,
+        sub: user.userId,
+        aud: oidc.url,
+        iat: timestampNow,
+        exp: timestampNow + 60 * 5
+      },
+      privateKey: user.key
+    });
+    const scopes = ['openid', 'profile', `urn:zitadel:iam:org:project:id:${oidc.projectId}:aud`];
+    try {
+      const res = await fetch(`${oidc.url}/oauth/v2/token`, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded'
+        },
+        body: new URLSearchParams({
+          grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+          scope: scopes.join(' '),
+          assertion: assertionToken
+        })
+      });
+      if (res.status >= 300) {
+        try {
+          const error = await res.json();
+          return failure(error.toString());
+        } catch {
+          return failure(res.statusText);
+        }
+      }
+      const token = await res.json();
+      const expireTimestamp = new Date().getTime() + token.expires_in * 1000;
+      return success({
+        accessToken: token.access_token,
+        expires: new Date(expireTimestamp)
+      });
+    } catch (error) {
+      return failure(`${error}`);
+    }
+  }
   async fetchFromEnter(endpoint, method, data) {
     const body = data !== null ? JSON.stringify(data) : null;
     const headers = {

package/dist/generated/api-schema.d.ts

@@ -65,6 +65,29 @@ export declare type paths = {
 };
 export declare type components = {
     schemas: {
+        /**
+         * AttendeeAuthCodeRequested
+         * @description A request to set an auth_code for the attendee
+         *
+         * This will generate and set an auth code for the attendee. If none is already set.
+         */
+        AttendeeAuthCodeRequested: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id?: string;
+            /**
+             * Event
+             * @default attendee-auth-code-requested
+             * @enum {string}
+             */
+            event: "attendee-auth-code-requested";
+            /** Instancename */
+            instanceName: string;
+            /** Attendeeid */
+            attendeeId: string;
+        };
         /**
          * AttendeeCreatedEvent
          * @description New attendee was created
@@ -135,6 +158,11 @@ export declare type components = {
             rsvp: {
                 [key: string]: number | null;
             };
+            /**
+             * Responsetime
+             * Format: date-time
+             */
+            responseTime?: string;
             /** Isedit */
             isEdit: boolean;
         };
@@ -213,55 +241,6 @@ export declare type components = {
              */
             suffix: string;
         };
-        /** AuthField */
-        AuthField: {
-            /**
-             * Type
-             * @default auth
-             * @enum {string}
-             */
-            type: "auth";
-            /**
-             * Name
-             * @default new_field
-             */
-            name: string;
-            /** Title */
-            title?: string | {
-                [key: string]: string;
-            };
-            /** Info */
-            info?: string | {
-                [key: string]: string;
-            };
-            /**
-             * Class
-             * @default
-             */
-            class: string;
-            /**
-             * Ismetafield
-             * @default false
-             */
-            isMetaField: boolean;
-            /**
-             * Static
-             * @default false
-             */
-            static: boolean;
-            /**
-             * Required
-             * @default false
-             */
-            required: boolean;
-            /**
-             * Hidden
-             * @default false
-             */
-            hidden: boolean;
-            /** Value */
-            value?: string;
-        };
         /** CheckboxField */
         CheckboxField: {
             /**
@@ -468,6 +447,65 @@ export declare type components = {
              */
             deleted: string[];
         };
+        /** CodeField */
+        CodeField: {
+            /**
+             * Type
+             * @default code
+             * @enum {string}
+             */
+            type: "code";
+            /**
+             * Name
+             * @default new_field
+             */
+            name: string;
+            /** Title */
+            title?: string | {
+                [key: string]: string;
+            };
+            /** Info */
+            info?: string | {
+                [key: string]: string;
+            };
+            /**
+             * Class
+             * @default
+             */
+            class: string;
+            /**
+             * Ismetafield
+             * @default false
+             */
+            isMetaField: boolean;
+            /**
+             * Static
+             * @default false
+             */
+            static: boolean;
+            /**
+             * Required
+             * @default false
+             */
+            required: boolean;
+            /**
+             * Hidden
+             * @default false
+             */
+            hidden: boolean;
+            /** Value */
+            value?: string;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 2000
+             */
+            max: number;
+        };
         /** CompanionJSON */
         CompanionJSON: {
             /**
@@ -632,10 +670,16 @@ export declare type components = {
             hidden: boolean;
             /** Value */
             value?: string;
-            /** Min */
-            min?: number;
-            /** Max */
-            max?: number;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 1000
+             */
+            max: number;
         };
         /**
          * EmailUnsubscribedEvent
@@ -658,11 +702,15 @@ export declare type components = {
             event: "email-unsubscribed";
             /** Instancename */
             instanceName: string;
+            /** Attendeeid */
+            attendeeId: string;
+            /** Emailname */
+            emailName: string;
             /** Emailaddress */
             emailAddress: string;
         };
         /** EventList */
-        EventList: (components["schemas"]["AttendeeCreatedEvent"] | components["schemas"]["AttendeeUpdatedEvent"] | components["schemas"]["AttendeeRespondedEvent"] | components["schemas"]["EmailUnsubscribedEvent"] | components["schemas"]["AttendeeDeletedEvent"] | components["schemas"]["CheckinCreatedEvent"] | components["schemas"]["CheckinDeletedEvent"] | components["schemas"]["PaymentPaidEvent"])[];
+        EventList: (components["schemas"]["AttendeeCreatedEvent"] | components["schemas"]["AttendeeUpdatedEvent"] | components["schemas"]["AttendeeRespondedEvent"] | components["schemas"]["AttendeeAuthCodeRequested"] | components["schemas"]["EmailUnsubscribedEvent"] | components["schemas"]["AttendeeDeletedEvent"] | components["schemas"]["CheckinCreatedEvent"] | components["schemas"]["CheckinDeletedEvent"] | components["schemas"]["PaymentPaidEvent"])[];
         /** EventResponse */
         EventResponse: {
             /** Created */
@@ -671,7 +719,7 @@ export declare type components = {
         /** FieldGroup */
         FieldGroup: {
             /** Questions */
-            questions: (components["schemas"]["TextField"] | components["schemas"]["StaticField"] | components["schemas"]["ImageUploadField"] | components["schemas"]["FileUploadField"] | components["schemas"]["LongtextField"] | components["schemas"]["RadioButtonField"] | components["schemas"]["RadioButtonGroupField"] | components["schemas"]["DropdownField"] | components["schemas"]["DateField"] | components["schemas"]["EmailField"] | components["schemas"]["AuthField"] | components["schemas"]["NumberField"] | components["schemas"]["CheckboxField"] | components["schemas"]["CheckboxGroupField"])[];
+            questions: (components["schemas"]["TextField"] | components["schemas"]["StaticField"] | components["schemas"]["ImageUploadField"] | components["schemas"]["FileUploadField"] | components["schemas"]["LongtextField"] | components["schemas"]["RadioButtonGroupField"] | components["schemas"]["DropdownField"] | components["schemas"]["DateField"] | components["schemas"]["EmailField"] | components["schemas"]["NumberField"] | components["schemas"]["CheckboxField"] | components["schemas"]["CheckboxGroupField"] | components["schemas"]["CodeField"])[];
             /** Info */
             info?: string | {
                 [key: string]: string;
@@ -735,7 +783,9 @@ export declare type components = {
              */
             hidden: boolean;
             /** Value */
-            value?: string;
+            value?: {
+                [key: string]: unknown;
+            };
             /** Min */
             min?: number;
             /** Max */
@@ -876,10 +926,16 @@ export declare type components = {
             hidden: boolean;
             /** Value */
             value?: string;
-            /** Min */
-            min?: number;
-            /** Max */
-            max?: number;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 1000
+             */
+            max: number;
         };
         /** MainGuestJSON */
         MainGuestJSON: {
@@ -937,10 +993,16 @@ export declare type components = {
             hidden: boolean;
             /** Value */
             value?: string;
-            /** Min */
-            min?: number;
-            /** Max */
-            max?: number;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 1000
+             */
+            max: number;
         };
         /** Payment */
         Payment: {
@@ -1094,57 +1156,6 @@ export declare type components = {
             /** Answer */
             answer: string;
         };
-        /** RadioButtonField */
-        RadioButtonField: {
-            /**
-             * Type
-             * @default radiobutton
-             * @enum {string}
-             */
-            type: "radiobutton";
-            /**
-             * Name
-             * @default new_field
-             */
-            name: string;
-            /** Title */
-            title?: string | {
-                [key: string]: string;
-            };
-            /** Info */
-            info?: string | {
-                [key: string]: string;
-            };
-            /**
-             * Class
-             * @default
-             */
-            class: string;
-            /**
-             * Ismetafield
-             * @default false
-             */
-            isMetaField: boolean;
-            /**
-             * Static
-             * @default false
-             */
-            static: boolean;
-            /**
-             * Required
-             * @default false
-             */
-            required: boolean;
-            /**
-             * Hidden
-             * @default false
-             */
-            hidden: boolean;
-            /** Value */
-            value?: string;
-            /** Itemval */
-            itemval?: string;
-        };
         /** RadioButtonGroupField */
         RadioButtonGroupField: {
             /**
@@ -1271,9 +1282,8 @@ export declare type components = {
             /**
              * Static
              * @default true
-             * @enum {boolean}
              */
-            static: true;
+            static: boolean;
             /**
              * Required
              * @default false
@@ -1286,6 +1296,16 @@ export declare type components = {
             hidden: boolean;
             /** Value */
             value?: string;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 1000
+             */
+            max: number;
         };
         /** TextField */
         TextField: {
@@ -1335,10 +1355,16 @@ export declare type components = {
             hidden: boolean;
             /** Value */
             value?: string;
-            /** Min */
-            min?: number;
-            /** Max */
-            max?: number;
+            /**
+             * Min
+             * @default 0
+             */
+            min: number;
+            /**
+             * Max
+             * @default 1000
+             */
+            max: number;
         };
         /** UserPreferencesUpdate */
         UserPreferencesUpdate: {

package/dist/models/field.d.ts

@@ -20,9 +20,6 @@ export declare type SingleCheckboxField = components['schemas']['CheckboxField']
 export declare type RadioField = components['schemas']['RadioButtonGroupField'] & {
     group: string;
 };
-export declare type SingleRadioField = components['schemas']['RadioButtonField'] & {
-    group: string;
-};
 export declare type SelectField = components['schemas']['DropdownField'] & {
     group: string;
 };

package/dist/models/index.d.ts

@@ -9,7 +9,7 @@ export type { Event, AttendeeUpdatedEvent, AttendeeCreatedEvent, AttendeeRespond
 export type { FieldGroup } from './field-group';
 export { FieldGroups } from './field-group';
 export type { FieldValue } from './field-value';
-export type { StaticField, TextField, EmailField, NumberField, CheckboxField, SingleCheckboxField, RadioField, SingleRadioField, SelectField, Field, } from './field';
+export type { StaticField, TextField, EmailField, NumberField, CheckboxField, SingleCheckboxField, RadioField, SelectField, Field, } from './field';
 export { Instance } from './instance';
 export type { InstanceJSON } from './instance';
 export type { Permission } from './permission';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dev-crew-berlin/enter-js-utils",
-  "version": "0.47.4",
+  "version": "0.49.0",
   "description": "utils such as vaildation and other helpers to work with data from the enter app",
   "files": [
     "dist",
@@ -52,6 +52,7 @@
     "@storybook/manager-webpack4": "^6.5.15",
     "@storybook/react": "^6.5.15",
     "@storybook/testing-library": "^0.0.13",
+    "@types/jws": "^3.2.9",
     "@types/node": "^17.0.38",
     "@types/react": "^18.0.10",
     "@types/react-dom": "^18.0.5",
@@ -72,6 +73,7 @@
   },
   "dependencies": {
     "fp-ts": "^2.12.1",
+    "jws": "^4.0.0",
     "styled-jsx": "^5.0.2",
     "uuid": "^9.0.0"
   }