@nu-art/push-pub-sub-shared 0.400.7

package/api.d.ts

@@ -0,0 +1,14 @@
+import { ApiDefResolver, BodyApi } from '@nu-art/thunderstorm-shared';
+import { BaseSubscriptionData, PushMessage, Request_PushRegister } from './types.js';
+export type Request_PushTest = {
+    message: PushMessage<any, any, any>;
+};
+export type ApiStruct_PushMessages = {
+    v1: {
+        test: BodyApi<void, Request_PushTest>;
+        unregister: BodyApi<void, Request_PushRegister, BaseSubscriptionData>;
+        register: BodyApi<void, Request_PushRegister, BaseSubscriptionData>;
+        registerAll: BodyApi<void, Request_PushRegister, BaseSubscriptionData[]>;
+    };
+};
+export declare const ApiDef_PushMessages: ApiDefResolver<ApiStruct_PushMessages>;

package/api.js

@@ -0,0 +1,26 @@
+/*
+ * A generic push pub sub infra for webapps
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { HttpMethod } from '@nu-art/thunderstorm-shared';
+export const ApiDef_PushMessages = {
+    v1: {
+        test: { method: HttpMethod.POST, path: 'v1/push-messages/test' },
+        unregister: { method: HttpMethod.POST, path: 'v1/push-messages/unregister' },
+        register: { method: HttpMethod.POST, path: 'v1/push-messages/register' },
+        registerAll: { method: HttpMethod.POST, path: 'v1/push-messages/register-all' }
+    }
+};

package/index.d.ts

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

package/index.js

@@ -0,0 +1,19 @@
+/*
+ * A generic push pub sub infra for webapps
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './api.js';
+export * from './types.js';

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@nu-art/push-pub-sub-shared",
+  "version": "0.400.7",
+  "description": "push-pub-sub Shared",
+  "keywords": [
+    "TacB0sS",
+    "express",
+    "infra",
+    "nu-art",
+    "push-pub-sub",
+    "thunderstorm",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/push-pub-sub.git"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "scripts": {
+    "build": "tsc -b -f"
+  },
+  "dependencies": {
+    "@nu-art/thunderstorm-shared": "0.400.7",
+    "@nu-art/ts-styles": "0.400.7",
+    "@nu-art/permissions-shared": "0.400.7",
+    "@nu-art/ts-common": "0.400.7",
+    "@nu-art/firebase-shared": "0.400.7",
+    "@nu-art/user-account-shared": "0.400.7",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "moment": "^2.29.4",
+    "react": "^18.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/push-messages-history/api-def.d.ts

@@ -0,0 +1,5 @@
+import { ApiDefResolver } from '@nu-art/thunderstorm-shared';
+export type ApiStruct_PushMessagesHistory = {
+    _v1: {};
+};
+export declare const ApiDef_PushMessagesHistory: ApiDefResolver<ApiStruct_PushMessagesHistory>;

package/push-messages-history/api-def.js

@@ -0,0 +1,3 @@
+export const ApiDef_PushMessagesHistory = {
+    _v1: {}
+};

package/push-messages-history/db-def.d.ts

@@ -0,0 +1,3 @@
+import { DBDef_V3 } from '@nu-art/ts-common';
+import { DBProto_PushMessagesHistory } from './types.js';
+export declare const DBDef_PushMessagesHistory: DBDef_V3<DBProto_PushMessagesHistory>;

package/push-messages-history/db-def.js

@@ -0,0 +1,24 @@
+import { convertUpperCamelCase, tsValidateBoolean, tsValidateMustExist, tsValidateString, tsValidateUniqueId } from '@nu-art/ts-common';
+import { PushPubSubDBGroup } from '../shared.js';
+const Validator_ModifiableProps = {};
+const Validator_GeneratedProps = {
+    pushSessionId: tsValidateString(),
+    token: tsValidateString(),
+    message: tsValidateMustExist,
+    read: tsValidateBoolean(),
+    originatingAccountId: tsValidateUniqueId,
+};
+export const DBDef_PushMessagesHistory = {
+    modifiablePropsValidator: Validator_ModifiableProps,
+    generatedPropsValidator: Validator_GeneratedProps,
+    versions: ['1.0.0'],
+    dbKey: 'push-messages-history',
+    entityName: convertUpperCamelCase('PushMessagesHistory', '-').toLowerCase(),
+    frontend: {
+        group: PushPubSubDBGroup,
+        name: 'message-history',
+    },
+    backend: {
+        name: 'push-messages-history'
+    }
+};

package/push-messages-history/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-messages-history/index.js

@@ -0,0 +1,4 @@
+// Generated DB Item type: PushMessagesHistory
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-messages-history/types.d.ts

@@ -0,0 +1,19 @@
+import { DB_Object, DBProto, Proto_DB_Object, VersionsDeclaration } from '@nu-art/ts-common';
+type VersionTypes_PushMessagesHistory = {
+    '1.0.0': DB_PushMessagesHistory;
+};
+type Versions = VersionsDeclaration<['1.0.0'], VersionTypes_PushMessagesHistory>;
+type Dependencies = {};
+type UniqueKeys = '_id';
+type GeneratedKeys = 'pushSessionId' | 'token' | 'message' | 'read' | 'originatingAccountId';
+type Proto = Proto_DB_Object<DB_PushMessagesHistory, 'push-messages-history', GeneratedKeys, Versions, UniqueKeys, Dependencies>;
+export type DBProto_PushMessagesHistory = DBProto<Proto>;
+export type UI_PushMessagesHistory = DBProto_PushMessagesHistory['uiType'];
+export type DB_PushMessagesHistory = DB_Object & {
+    pushSessionId: string;
+    token: string;
+    message: any;
+    read: boolean;
+    originatingAccountId: string;
+};
+export {};

package/push-messages-history/types.js

@@ -0,0 +1 @@
+export {};

package/push-session/api-def.d.ts

@@ -0,0 +1,5 @@
+import { ApiDefResolver } from '@nu-art/thunderstorm-shared';
+export type ApiStruct_PushSession = {
+    _v1: {};
+};
+export declare const ApiDef_PushSession: ApiDefResolver<ApiStruct_PushSession>;

package/push-session/api-def.js

@@ -0,0 +1,3 @@
+export const ApiDef_PushSession = {
+    _v1: {}
+};

package/push-session/db-def.d.ts

@@ -0,0 +1,3 @@
+import { DBDef_V3 } from '@nu-art/ts-common';
+import { DBProto_PushSession } from './types.js';
+export declare const DBDef_PushSession: DBDef_V3<DBProto_PushSession>;

package/push-session/db-def.js

@@ -0,0 +1,24 @@
+import { convertUpperCamelCase, tsValidateString, tsValidateTimestamp, tsValidateUniqueId } from '@nu-art/ts-common';
+import { PushPubSubDBGroup } from '../shared.js';
+const Validator_ModifiableProps = {
+    accountId: tsValidateUniqueId,
+    pushSessionId: tsValidateString(),
+    firebaseToken: tsValidateString(),
+    timestamp: tsValidateTimestamp()
+};
+const Validator_GeneratedProps = {};
+export const DBDef_PushSession = {
+    modifiablePropsValidator: Validator_ModifiableProps,
+    generatedPropsValidator: Validator_GeneratedProps,
+    versions: ['1.0.0'],
+    uniqueKeys: ['pushSessionId'],
+    dbKey: 'push-session',
+    entityName: convertUpperCamelCase('PushSession', '-').toLowerCase(),
+    frontend: {
+        group: PushPubSubDBGroup,
+        name: 'session',
+    },
+    backend: {
+        name: 'push-session'
+    }
+};

package/push-session/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-session/index.js

@@ -0,0 +1,4 @@
+// Generated DB Item type: PushSession
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-session/types.d.ts

@@ -0,0 +1,16 @@
+import { DB_Object, DBProto, Proto_DB_Object, VersionsDeclaration } from '@nu-art/ts-common';
+import { FirebaseToken, PushSessionId } from '../types.js';
+type VersionTypes_PushSession = {
+    '1.0.0': DB_PushSession;
+};
+type Versions = VersionsDeclaration<['1.0.0'], VersionTypes_PushSession>;
+type Dependencies = {};
+type UniqueKeys = 'pushSessionId';
+type Proto = Proto_DB_Object<DB_PushSession, 'push-session', never, Versions, UniqueKeys, Dependencies>;
+export type DBProto_PushSession = DBProto<Proto>;
+export type UI_PushSession = DBProto_PushSession['uiType'];
+export type DB_PushSession = DB_Object & FirebaseToken & PushSessionId & {
+    timestamp: number;
+    accountId: string;
+};
+export {};

package/push-session/types.js

@@ -0,0 +1 @@
+export {};

package/push-subscription/api-def.d.ts

@@ -0,0 +1,5 @@
+import { ApiDefResolver } from '@nu-art/thunderstorm-shared';
+export type ApiStruct_PushSubscription = {
+    _v1: {};
+};
+export declare const ApiDef_PushSubscription: ApiDefResolver<ApiStruct_PushSubscription>;

package/push-subscription/api-def.js

@@ -0,0 +1,3 @@
+export const ApiDef_PushSubscription = {
+    _v1: {}
+};

package/push-subscription/db-def.d.ts

@@ -0,0 +1,3 @@
+import { DBDef_V3 } from '@nu-art/ts-common';
+import { DBProto_PushSubscription } from './types.js';
+export declare const DBDef_PushSubscription: DBDef_V3<DBProto_PushSubscription>;

package/push-subscription/db-def.js

@@ -0,0 +1,33 @@
+import { convertUpperCamelCase, exists, tsValidateDynamicObject, tsValidateMustExist, tsValidateNumber, tsValidateResult, tsValidateString } from '@nu-art/ts-common';
+import { PushPubSubDBGroup } from '../shared.js';
+const Validator_FilterKey = (value) => {
+    if (typeof value === 'string')
+        return tsValidateResult(value, tsValidateString());
+    if (typeof value === 'number')
+        return tsValidateResult(value, tsValidateNumber());
+    if (exists(value))
+        return `expected type number | string but received ${typeof value}`;
+    return tsValidateResult(value, tsValidateMustExist);
+};
+const Validator_ModifiableProps = {
+    pushSessionId: tsValidateString(),
+    filter: tsValidateDynamicObject(Validator_FilterKey, tsValidateString(), false),
+    topic: tsValidateString(200)
+};
+const Validator_GeneratedProps = {
+//
+};
+export const DBDef_PushSubscription = {
+    modifiablePropsValidator: Validator_ModifiableProps,
+    generatedPropsValidator: Validator_GeneratedProps,
+    versions: ['1.0.0'],
+    dbKey: 'push-subscription',
+    entityName: convertUpperCamelCase('PushSubscription', '-').toLowerCase(),
+    frontend: {
+        group: PushPubSubDBGroup,
+        name: 'subscription',
+    },
+    backend: {
+        name: 'push-subscription'
+    }
+};

package/push-subscription/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-subscription/index.js

@@ -0,0 +1,4 @@
+// Generated DB Item type: PushSubscription
+export * from './types.js';
+export * from './db-def.js';
+export * from './api-def.js';

package/push-subscription/types.d.ts

@@ -0,0 +1,13 @@
+import { DB_Object, DBProto, Proto_DB_Object, VersionsDeclaration } from '@nu-art/ts-common';
+import { BaseSubscriptionData, PushSessionId } from '../types.js';
+type VersionTypes_PushSubscription = {
+    '1.0.0': DB_PushSubscription;
+};
+type Versions = VersionsDeclaration<['1.0.0'], VersionTypes_PushSubscription>;
+type Dependencies = {};
+type UniqueKeys = '_id';
+type Proto = Proto_DB_Object<DB_PushSubscription, 'push-subscription', never, Versions, UniqueKeys, Dependencies>;
+export type DBProto_PushSubscription = DBProto<Proto>;
+export type UI_PushSubscription = DBProto_PushSubscription['uiType'];
+export type DB_PushSubscription = DB_Object & PushSessionId & BaseSubscriptionData;
+export {};

package/push-subscription/types.js

@@ -0,0 +1 @@
+export {};

package/shared.d.ts

@@ -0,0 +1 @@
+export declare const PushPubSubDBGroup = "push-pub-sub";

package/shared.js

@@ -0,0 +1 @@
+export const PushPubSubDBGroup = 'push-pub-sub';

package/types.d.ts

@@ -0,0 +1,46 @@
+import { DB_Object } from '@nu-art/ts-common';
+export type FilterProps = {
+    [prop: string]: string | number;
+};
+export type BaseSubscriptionData = {
+    filter?: FilterProps;
+    topic: string;
+};
+export type Request_PushRegister = FirebaseToken & PushSessionId & {
+    subscriptions: BaseSubscriptionData[];
+};
+export type DB_PushSession = FirebaseToken & PushSessionId & {
+    timestamp: number;
+    userId: string;
+};
+export type DB_Notifications<MessageType> = DB_Object & {
+    message: MessageType;
+    userId?: string;
+    timestamp: number;
+    read: boolean;
+    persistent?: boolean;
+};
+export type DB_PushSubscription = PushSessionId & BaseSubscriptionData;
+export type FirebaseToken = {
+    firebaseToken: string;
+};
+export type PushSessionId = {
+    pushSessionId: string;
+};
+export type PushMessage<Topic extends string, Filter extends FilterProps, Data = never> = {
+    topic: Topic;
+    filter: Filter;
+    data: Data;
+};
+export type PushMessage_PayloadWrapper = {
+    sessionId: string;
+    payload: string;
+};
+export type PushMessage_Payload<MessageType extends PushMessage<any, any, any> = PushMessage<any, any, any>> = BaseSubscriptionData & {
+    _id: string;
+    timestamp: number;
+    message: MessageType['data'];
+};
+export interface OnPushMessageReceived<MessageType extends PushMessage<any, any, any> = PushMessage<any, any, any>> {
+    __onMessageReceived(notification: PushMessage_Payload<MessageType>): void;
+}

package/types.js

@@ -0,0 +1 @@
+export {};