@ngageoint/mage.service 6.2.2

package/lib/app.api/app.api.errors.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.infrastructureError = exports.invalidInput = exports.entityNotFound = exports.permissionDenied = exports.MageError = exports.ErrInfrastructure = exports.ErrEntityNotFound = exports.ErrInvalidInput = exports.ErrPermissionDenied = void 0;
+exports.ErrPermissionDenied = Symbol.for('MageError.PermissionDenied');
+exports.ErrInvalidInput = Symbol.for('MageError.InvalidInput');
+exports.ErrEntityNotFound = Symbol.for('MageError.EntityNotFound');
+exports.ErrInfrastructure = Symbol.for('MageError.Infrastructure');
+class MageError extends Error {
+    constructor(code, data, message) {
+        super(message ? message : Symbol.keyFor(code));
+        this.code = code;
+        this.data = data;
+        this.name = Symbol.keyFor(code) || 'MageError';
+    }
+}
+exports.MageError = MageError;
+function permissionDenied(permission, subject, object) {
+    const message = `${subject} does not have permission ${permission}` + (object ? ` on ${object}` : '');
+    return new MageError(exports.ErrPermissionDenied, { permission, subject, object: object || null }, message);
+}
+exports.permissionDenied = permissionDenied;
+function entityNotFound(entityId, entityType, message) {
+    return new MageError(exports.ErrEntityNotFound, { entityId, entityType }, message || `${entityType} not found: ${entityId}`);
+}
+exports.entityNotFound = entityNotFound;
+function invalidInput(summary, ...errors) {
+    const message = errors.reduce((message, keyPathError) => {
+        let err = keyPathError[0];
+        if (typeof err === 'object' && 'message' in err) {
+            err = err.message;
+        }
+        const keyPath = keyPathError.slice(1, keyPathError.length);
+        return message + `\n  ${keyPath.join(' > ')}: ${err}`;
+    }, summary || 'invalid request');
+    return new MageError(exports.ErrInvalidInput, errors, message);
+}
+exports.invalidInput = invalidInput;
+function infrastructureError(why) {
+    const message = String(why);
+    return new MageError(exports.ErrInfrastructure, null, message);
+}
+exports.infrastructureError = infrastructureError;
+//# sourceMappingURL=app.api.errors.js.map

package/lib/app.api/app.api.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.errors.js","sourceRoot":"","sources":["../../src/app.api/app.api.errors.ts"],"names":[],"mappings":";;;AACa,QAAA,mBAAmB,GAAG,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;AAC9D,QAAA,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;AACtD,QAAA,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;AAC1D,QAAA,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;AAevE,MAAa,SAA4C,SAAQ,KAAK;IACpE,YAA4B,IAAU,EAAW,IAAU,EAAE,OAAgB;QAC3E,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;QADpB,SAAI,GAAJ,IAAI,CAAM;QAAW,SAAI,GAAJ,IAAI,CAAM;QAEzD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAA;IAChD,CAAC;CACF;AALD,8BAKC;AAaD,SAAgB,gBAAgB,CAAC,UAAkB,EAAE,OAAe,EAAE,MAAe;IACnF,MAAM,OAAO,GAAG,GAAG,OAAO,6BAA6B,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACrG,OAAO,IAAI,SAAS,CAAC,2BAAmB,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;AACrG,CAAC;AAHD,4CAGC;AAED,SAAgB,cAAc,CAAC,QAAa,EAAE,UAAkB,EAAE,OAAgB;IAChF,OAAO,IAAI,SAAS,CAAC,yBAAiB,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,OAAO,IAAI,GAAG,UAAU,eAAe,QAAQ,EAAE,CAAC,CAAA;AACtH,CAAC;AAFD,wCAEC;AAED,SAAgB,YAAY,CAAC,OAAgB,EAAE,GAAG,MAAsB;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE;QACtD,IAAI,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;QACzB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,SAAS,IAAI,GAAG,EAAE;YAC/C,GAAG,GAAG,GAAG,CAAC,OAAO,CAAA;SAClB;QACD,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;QAC1D,OAAO,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAA;IACvD,CAAC,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAA;IAChC,OAAO,IAAI,SAAS,CAAC,uBAAe,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AACxD,CAAC;AAVD,oCAUC;AAED,SAAgB,mBAAmB,CAAC,GAAmB;IACrD,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;IAC3B,OAAO,IAAI,SAAS,CAAC,yBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACxD,CAAC;AAHD,kDAGC"}

package/lib/app.api/app.api.global.d.ts

@@ -0,0 +1,74 @@
+import { MageError, PermissionDeniedError } from './app.api.errors';
+import { JsonObject } from '../entities/entities.json_types';
+import { LanguageTag, Locale } from '../entities/entities.i18n';
+export interface AppRequestContext<Principal = unknown> {
+    /**
+     * The request token is a value the adapter layer injects to track the
+     * request.  This is necessary to achieve the same effect as a "thread-local"
+     * variable that a Java application would use.  Node does not use the model
+     * of one thread per request, so some unique value is necessary to track a
+     * request context across multiple asynchronous operations.
+     */
+    readonly requestToken: unknown;
+    requestingPrincipal(): Principal;
+    /**
+     * Return localization information associated with the request, such as the
+     * language preference of the client.
+     */
+    locale(): Locale | null;
+}
+export interface AppRequest<Principal = unknown, Context extends AppRequestContext<Principal> = AppRequestContext<Principal>> {
+    context: Context;
+}
+/**
+ * `Descriptor` is a simple interface that marks child interfaces as a
+ * descriptor whose purpose is essentially a data transfer object that service
+ * clients consume.  The interface provides one property, `descriptorOf`.
+ * The `descriptorOf` property helps to identify the domain type the
+ * descriptor represents.  This can be helpful because JSON documents may not
+ * be immediately distinguishable in the wild.  Child interfaces should
+ * override the property to be a constant string value, e.g.,
+ * ```
+ * interface UserDescriptor extends Descriptor {
+ *   descriptorOf: 'mage.User',
+ *   userName: string,
+ *   // ... more user properties suitable for the client
+ * }
+ * ```
+ */
+export interface Descriptor<T extends string> extends JsonObject {
+    descriptorOf: T;
+}
+/**
+ * This type simply maps a union of types only if the types extend from MageError.
+ */
+export declare type AnyMageError<KnownErrors> = KnownErrors extends MageError<infer Code, infer Data> ? MageError<Code, Data> : never;
+export declare class AppResponse<Success, KnownErrors> {
+    readonly success: Success | null;
+    readonly error: KnownErrors | null;
+    readonly contentLanguage?: LanguageTag[] | null | undefined;
+    static success<Success, KnownErrors>(result: Success, contentLanguage?: LanguageTag[] | null | undefined): AppResponse<Success, AnyMageError<KnownErrors>>;
+    static error<KnownErrors>(result: KnownErrors, contentLanguage?: LanguageTag[] | null | undefined): AppResponse<any, KnownErrors>;
+    static resultOf<Success, KnownErrors>(promise: Promise<Success | AnyMageError<KnownErrors>>): Promise<AppResponse<Success, AnyMageError<KnownErrors>>>;
+    private constructor();
+}
+/**
+ * This type provides a shorthand to map the given operation type argument to
+ * its known, checked errors that its Promise might resolve in an [AppResponse].
+ */
+export declare type KnownErrorsOf<T> = T extends (...args: any[]) => Promise<AppResponse<infer Success, infer KnownErrors>> ? Success extends MageError<any, any> ? never : KnownErrors extends MageError<any, any> ? KnownErrors : never : never;
+/**
+ * Wait for the given permission check to resolve.  If the permission check
+ * succeeds, perform the given operation and return the result as an
+ * [AppResponse].  If the permission check fails, return an error [AppResponse]
+ * with a [PermissionDeniedError]  This function provides a simple way to always
+ * return the appropriate [AppResponse] an app operation requires.
+ *
+ * @param permissionCheck a Promise that resolves to a permission result
+ * @param op the operation to perform if the permission check succeeds
+ *
+ * TODO: localization
+ * permission check would localize its error message presumably
+ */
+export declare function withPermission<Success, KnownErrors>(permissionCheck: Promise<PermissionDeniedError | null>, op: (...args: any[]) => Promise<Success | AnyMageError<KnownErrors>>): Promise<AppResponse<Success, AnyMageError<KnownErrors | PermissionDeniedError>>>;
+//# sourceMappingURL=app.api.global.d.ts.map

package/lib/app.api/app.api.global.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.global.d.ts","sourceRoot":"","sources":["../../src/app.api/app.api.global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAE/D,MAAM,WAAW,iBAAiB,CAAC,SAAS,GAAG,OAAO;IACpD;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,mBAAmB,IAAI,SAAS,CAAA;IAChC;;;OAGG;IACH,MAAM,IAAI,MAAM,GAAG,IAAI,CAAA;CACxB;AAGD,MAAM,WAAW,UAAU,CAAC,SAAS,GAAG,OAAO,EAAE,OAAO,SAAS,iBAAiB,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,SAAS,CAAC;IAC1H,OAAO,EAAE,OAAO,CAAA;CACjB;AAGD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,MAAM,CAAE,SAAQ,UAAU;IAC9D,YAAY,EAAE,CAAC,CAAA;CAChB;AAED;;GAEG;AACH,oBAAY,YAAY,CAAC,WAAW,IAAI,WAAW,SAAS,SAAS,CAAC,MAAM,IAAI,EAAE,MAAM,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,KAAK,CAAA;AAE7H,qBAAa,WAAW,CAAC,OAAO,EAAE,WAAW;IAoBvB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAAE,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAAE,QAAQ,CAAC,eAAe,CAAC;IAlBnH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IAI1J,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI,GAAG,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC;IAIjI,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;IAUtJ,OAAO;CACR;AAED;;;GAGG;AACH,oBAAY,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,WAAW,CAAC,MAAM,OAAO,EAAE,MAAM,WAAW,CAAC,CAAC,GACjH,OAAO,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,GAC3C,WAAW,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,WAAW,GACrD,KAAK,GAAG,KAAK,CAAA;AAEf;;;;;;;;;;;;GAYG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,WAAW,EACvD,eAAe,EAAE,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,EACtD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAMxJ"}

package/lib/app.api/app.api.global.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withPermission = exports.AppResponse = void 0;
+const app_api_errors_1 = require("./app.api.errors");
+class AppResponse {
+    constructor(success, error, contentLanguage) {
+        this.success = success;
+        this.error = error;
+        this.contentLanguage = contentLanguage;
+    }
+    static success(result, contentLanguage) {
+        return new AppResponse(result, null, contentLanguage);
+    }
+    static error(result, contentLanguage) {
+        return new AppResponse(null, result, contentLanguage);
+    }
+    static resultOf(promise) {
+        return promise.then(successOrKnownError => {
+            if (successOrKnownError instanceof app_api_errors_1.MageError) {
+                return AppResponse.error(successOrKnownError);
+            }
+            return AppResponse.success(successOrKnownError);
+        });
+    }
+}
+exports.AppResponse = AppResponse;
+/**
+ * Wait for the given permission check to resolve.  If the permission check
+ * succeeds, perform the given operation and return the result as an
+ * [AppResponse].  If the permission check fails, return an error [AppResponse]
+ * with a [PermissionDeniedError]  This function provides a simple way to always
+ * return the appropriate [AppResponse] an app operation requires.
+ *
+ * @param permissionCheck a Promise that resolves to a permission result
+ * @param op the operation to perform if the permission check succeeds
+ *
+ * TODO: localization
+ * permission check would localize its error message presumably
+ */
+function withPermission(permissionCheck, op) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const denied = yield permissionCheck;
+        if (denied) {
+            return AppResponse.error(denied);
+        }
+        return yield AppResponse.resultOf(op());
+    });
+}
+exports.withPermission = withPermission;
+//# sourceMappingURL=app.api.global.js.map

package/lib/app.api/app.api.global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.global.js","sourceRoot":"","sources":["../../src/app.api/app.api.global.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAmE;AAoDnE,MAAa,WAAW;IAoBtB,YAA6B,OAAuB,EAAW,KAAyB,EAAW,eAAkD;QAAxH,YAAO,GAAP,OAAO,CAAgB;QAAW,UAAK,GAAL,KAAK,CAAoB;QAAW,oBAAe,GAAf,eAAe,CAAmC;IAAG,CAAC;IAlBzJ,MAAM,CAAC,OAAO,CAAuB,MAAe,EAAE,eAAkD;QACtG,OAAO,IAAI,WAAW,CAAqC,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAA;IAC3F,CAAC;IAED,MAAM,CAAC,KAAK,CAAc,MAAmB,EAAE,eAAkD;QAC/F,OAAO,IAAI,WAAW,CAAmB,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAuB,OAAqD;QACzF,OAAO,OAAO,CAAC,IAAI,CACjB,mBAAmB,CAAC,EAAE;YACpB,IAAI,mBAAmB,YAAY,0BAAS,EAAE;gBAC5C,OAAO,WAAW,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;aAC9C;YACD,OAAO,WAAW,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;IACN,CAAC;CAGF;AArBD,kCAqBC;AAWD;;;;;;;;;;;;GAYG;AACH,SAAsB,cAAc,CAClC,eAAsD,EACtD,EAAoE;;QACpE,MAAM,MAAM,GAAG,MAAM,eAAe,CAAA;QACpC,IAAI,MAAM,EAAE;YACV,OAAO,WAAW,CAAC,KAAK,CAAwB,MAAM,CAAC,CAAA;SACxD;QACD,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAuB,EAAE,EAAE,CAAC,CAAA;IAC/D,CAAC;CAAA;AARD,wCAQC"}

package/lib/app.api/events/app.api.events.d.ts

@@ -0,0 +1,31 @@
+import { AppRequest, AppResponse } from '../app.api.global';
+import { FeedId, Feed } from '../../entities/feeds/entities.feeds';
+import { MageEventId, MageEventAttrs } from '../../entities/events/entities.events';
+import { EntityNotFoundError, PermissionDeniedError } from '../app.api.errors';
+import { Localized } from '../../entities/entities.i18n';
+export interface AddFeedToEventRequest extends AppRequest {
+    feed: FeedId;
+    event: MageEventId;
+}
+export interface AddFeedToEvent {
+    (req: AddFeedToEventRequest): Promise<AppResponse<MageEventAttrs, PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface ListEventFeedsRequest extends AppRequest {
+    event: MageEventId;
+}
+/**
+ * This is a user-facing feed document that omits the constant parameters from
+ * the feed entity for security.
+ */
+export declare type UserFeed = Omit<Feed, 'constantParams'>;
+export interface ListEventFeeds {
+    (req: ListEventFeedsRequest): Promise<AppResponse<Localized<UserFeed>[], PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface RemoveFeedFromEventRequest extends AppRequest {
+    event: MageEventId;
+    feed: FeedId;
+}
+export interface RemoveFeedFromEvent {
+    (req: RemoveFeedFromEventRequest): Promise<AppResponse<MageEventAttrs, PermissionDeniedError | EntityNotFoundError>>;
+}
+//# sourceMappingURL=app.api.events.d.ts.map

package/lib/app.api/events/app.api.events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.events.d.ts","sourceRoot":"","sources":["../../../src/app.api/events/app.api.events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAExD,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CAChH;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,KAAK,EAAE,WAAW,CAAA;CACnB;AAED;;;GAGG;AACH,oBAAY,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAA;AAEnD,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACvH;AAED,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D,KAAK,EAAE,WAAW,CAAC;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,0BAA0B,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACrH"}

package/lib/app.api/events/app.api.events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=app.api.events.js.map

package/lib/app.api/events/app.api.events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.events.js","sourceRoot":"","sources":["../../../src/app.api/events/app.api.events.ts"],"names":[],"mappings":""}

package/lib/app.api/feeds/app.api.feeds.d.ts

@@ -0,0 +1,139 @@
+/// <reference types="node" />
+import { AppRequest, AppResponse, Descriptor, AppRequestContext, KnownErrorsOf } from '../app.api.global';
+import { FeedService, FeedTopic, FeedContent, FeedId, FeedServiceTypeId, FeedServiceId, Feed, FeedServiceType, FeedContentParams, FeedCreateMinimal, FeedUpdateMinimal, FeedCreateAttrs } from '../../entities/feeds/entities.feeds';
+import { Json, JsonObject } from '../../entities/entities.json_types';
+import { PermissionDeniedError, EntityNotFoundError, InvalidInputError, InfrastructureError } from '../app.api.errors';
+import { StaticIconReference } from '../../entities/icons/entities.icons';
+import { URL } from 'url';
+export interface ListFeedServiceTypes {
+    (req: AppRequest): Promise<AppResponse<FeedServiceTypeDescriptor[], PermissionDeniedError | InfrastructureError>>;
+}
+export interface PreviewTopicsRequest extends AppRequest {
+    serviceType: FeedServiceTypeId;
+    serviceConfig: Json;
+}
+export interface PreviewTopics {
+    (req: PreviewTopicsRequest): Promise<AppResponse<FeedTopic[], PermissionDeniedError | EntityNotFoundError | InvalidInputError | InfrastructureError>>;
+}
+export interface CreateFeedServiceRequest extends AppRequest {
+    serviceType: FeedServiceTypeId;
+    title: string;
+    summary?: string | null;
+    config: Json;
+}
+export interface CreateFeedService {
+    (req: CreateFeedServiceRequest): Promise<AppResponse<FeedService, PermissionDeniedError | EntityNotFoundError | InvalidInputError>>;
+}
+export interface ListFeedServices {
+    (req: AppRequest): Promise<AppResponse<FeedService[], PermissionDeniedError>>;
+}
+export interface GetFeedServiceRequest extends AppRequest {
+    service: FeedServiceId;
+}
+export declare type FeedServiceExpanded = Omit<FeedService, 'serviceType'> & {
+    serviceType: FeedServiceTypeDescriptor;
+};
+export interface GetFeedService {
+    (req: GetFeedServiceRequest): Promise<AppResponse<FeedServiceExpanded, PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface DeleteFeedServiceRequest extends AppRequest {
+    service: FeedServiceId;
+}
+export interface DeleteFeedService {
+    (req: DeleteFeedServiceRequest): Promise<AppResponse<true, PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface ListServiceTopicsRequest extends AppRequest {
+    service: FeedServiceId;
+}
+export interface ListServiceTopics {
+    (req: ListServiceTopicsRequest): Promise<AppResponse<FeedTopic[], PermissionDeniedError | EntityNotFoundError | InfrastructureError>>;
+}
+export declare type FeedCreateMinimalAcceptingStringUrls = Omit<FeedCreateMinimal, 'icon' | 'mapStyle'> & {
+    icon?: FeedUpdateMinimal['icon'] | AcceptStringUrls<FeedUpdateMinimal['icon']>;
+    mapStyle?: FeedUpdateMinimal['mapStyle'] | AcceptStringIconUrls<FeedUpdateMinimal['mapStyle']>;
+};
+export interface CreateFeedRequest extends AppRequest {
+    feed: FeedCreateMinimalAcceptingStringUrls;
+}
+export interface PreviewFeedRequest extends CreateFeedRequest {
+    skipContentFetch?: boolean;
+    variableParams?: FeedContentParams;
+}
+export interface FeedPreview {
+    feed: FeedCreateAttrs;
+    content?: FeedContent & {
+        feed: 'preview';
+    };
+}
+export interface PreviewFeed {
+    (req: PreviewFeedRequest): Promise<AppResponse<FeedPreview, KnownErrorsOf<CreateFeed> | InfrastructureError>>;
+}
+export interface CreateFeed {
+    (req: CreateFeedRequest): Promise<AppResponse<FeedExpanded, PermissionDeniedError | EntityNotFoundError | InvalidInputError | InfrastructureError>>;
+}
+export interface ListAllFeeds {
+    (req: AppRequest): Promise<AppResponse<Feed[], PermissionDeniedError>>;
+}
+export interface ListServiceFeedsRequest extends AppRequest {
+    service: FeedServiceId;
+}
+export interface ListServiceFeeds {
+    (req: ListServiceFeedsRequest): Promise<AppResponse<Feed[], PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface GetFeedRequest extends AppRequest {
+    feed: FeedId;
+}
+export declare type FeedExpanded = Omit<Feed, 'service' | 'topic'> & {
+    service: FeedService;
+    topic: FeedTopic;
+};
+export interface GetFeed {
+    (req: GetFeedRequest): Promise<AppResponse<FeedExpanded, PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface UpdateFeedRequest extends AppRequest {
+    feed: Omit<FeedUpdateMinimal, 'icon' | 'mapStyle'> & {
+        icon?: FeedUpdateMinimal['icon'] | AcceptStringUrls<FeedUpdateMinimal['icon']>;
+        mapStyle?: FeedUpdateMinimal['mapStyle'] | AcceptStringIconUrls<FeedUpdateMinimal['mapStyle']>;
+    };
+}
+export interface UpdateFeed {
+    (req: UpdateFeedRequest): Promise<AppResponse<FeedExpanded, PermissionDeniedError | EntityNotFoundError | InvalidInputError | InfrastructureError>>;
+}
+export interface DeleteFeedRequest extends AppRequest {
+    feed: FeedId;
+}
+export interface DeleteFeed {
+    (req: DeleteFeedRequest): Promise<AppResponse<true, PermissionDeniedError | EntityNotFoundError>>;
+}
+export interface FetchFeedContentRequest extends AppRequest {
+    feed: FeedId;
+    variableParams?: FeedContentParams;
+}
+export interface FetchFeedContent {
+    (req: FetchFeedContentRequest): Promise<AppResponse<FeedContent, PermissionDeniedError | EntityNotFoundError | InvalidInputError | InfrastructureError>>;
+}
+export interface FeedServiceTypeDescriptor extends Descriptor<'FeedServiceType'>, Pick<FeedServiceType, 'id' | 'title' | 'summary' | 'pluginServiceTypeId'> {
+    id: string;
+    configSchema: JsonObject | null;
+}
+export declare function FeedServiceTypeDescriptor(from: FeedServiceType): FeedServiceTypeDescriptor;
+export interface FeedServiceDescriptor extends Descriptor<'FeedService'>, Pick<FeedService, 'id' | 'serviceType' | 'title' | 'summary' | 'config'> {
+    serviceType: string;
+}
+export declare function FeedServiceDescriptor(from: FeedService): FeedServiceDescriptor;
+export interface FeedsPermissionService {
+    ensureListServiceTypesPermissionFor(context: AppRequestContext): Promise<PermissionDeniedError | null>;
+    ensureCreateServicePermissionFor(context: AppRequestContext): Promise<PermissionDeniedError | null>;
+    ensureListServicesPermissionFor(context: AppRequestContext): Promise<PermissionDeniedError | null>;
+    ensureListTopicsPermissionFor(context: AppRequestContext, service: FeedServiceId): Promise<PermissionDeniedError | null>;
+    ensureCreateFeedPermissionFor(context: AppRequestContext, service: FeedServiceId): Promise<PermissionDeniedError | null>;
+    ensureListAllFeedsPermissionFor(context: AppRequestContext): Promise<PermissionDeniedError | null>;
+    ensureFetchFeedContentPermissionFor(context: AppRequestContext, feed: FeedId): Promise<PermissionDeniedError | null>;
+}
+export declare type AcceptStringIconUrls<T> = {
+    [K in keyof T]: T[K] extends StaticIconReference | null | undefined ? AcceptStringUrls<T[K]> : T[K];
+};
+export declare type AcceptStringUrls<T> = {
+    [K in keyof T]: T[K] extends URL | undefined | null ? T[K] | string : T[K];
+};
+//# sourceMappingURL=app.api.feeds.d.ts.map

package/lib/app.api/feeds/app.api.feeds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.feeds.d.ts","sourceRoot":"","sources":["../../../src/app.api/feeds/app.api.feeds.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACzG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,iBAAiB,EAAE,aAAa,EAAE,IAAI,EAAE,eAAe,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACpO,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACtH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAGzB,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,yBAAyB,EAAE,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CAClH;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,WAAW,EAAE,iBAAiB,CAAA;IAC9B,aAAa,EAAE,IAAI,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACtJ;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,WAAW,EAAE,iBAAiB,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,EAAE,IAAI,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,CAAC,CAAC,CAAA;CACpI;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAA;CAC9E;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,OAAO,EAAE,aAAa,CAAA;CACvB;AAED,oBAAY,mBAAmB,GAAG,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,GAAG;IAAE,WAAW,EAAE,yBAAyB,CAAA;CAAE,CAAA;AAE/G,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACrH;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,OAAO,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACzG;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,OAAO,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACtI;AAED,oBAAY,oCAAoC,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,UAAU,CAAC,GAAG;IAChG,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAA;IAC9E,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAA;CAC/F,CAAA;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,oCAAoC,CAAA;CAC3C;AAED,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,cAAc,CAAC,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,eAAe,CAAA;IACrB,OAAO,CAAC,EAAE,WAAW,GAAG;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,CAAA;CAC5C;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAA;CAC9G;AAED,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACpJ;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAA;CACvE;AAED,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,OAAO,EAAE,aAAa,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CAC1G;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,MAAM,CAAA;CACb;AAED,oBAAY,YAAY,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,GAAG;IAC3D,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE,SAAS,CAAA;CACjB,CAAA;AAED,MAAM,WAAW,OAAO;IACtB,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACvG;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,UAAU,CAAC,GAAG;QACnD,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAA;QAC9E,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAA;KAC/F,CAAA;CACF;AAED,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACpJ;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,UAAU;IACzB,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CAClG;AAED,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,iBAAiB,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,mBAAmB,CAAC,CAAC,CAAA;CACzJ;AAED,MAAM,WAAW,yBAA0B,SAAQ,UAAU,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,GAAG,qBAAqB,CAAC;IACzJ,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,UAAU,GAAG,IAAI,CAAA;CAChC;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,eAAe,GAAG,yBAAyB,CAS1F;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,aAAa,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IAChJ,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,WAAW,GAAG,qBAAqB,CAS9E;AAED,MAAM,WAAW,sBAAsB;IACrC,mCAAmC,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACtG,gCAAgC,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACnG,+BAA+B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IAClG,6BAA6B,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACxH,6BAA6B,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IACxH,+BAA+B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;IAClG,mCAAmC,CAAC,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;CACrH;AAED,oBAAY,oBAAoB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,mBAAmB,GAAG,IAAI,GAAG,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAC7I,oBAAY,gBAAgB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,GAAG,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA"}

package/lib/app.api/feeds/app.api.feeds.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeedServiceDescriptor = exports.FeedServiceTypeDescriptor = void 0;
+function FeedServiceTypeDescriptor(from) {
+    return {
+        descriptorOf: 'FeedServiceType',
+        id: from.id,
+        pluginServiceTypeId: from.pluginServiceTypeId,
+        title: from.title,
+        summary: from.summary,
+        configSchema: from.configSchema
+    };
+}
+exports.FeedServiceTypeDescriptor = FeedServiceTypeDescriptor;
+function FeedServiceDescriptor(from) {
+    return {
+        descriptorOf: 'FeedService',
+        id: from.id,
+        serviceType: from.serviceType,
+        title: from.title,
+        summary: from.summary,
+        config: from.config
+    };
+}
+exports.FeedServiceDescriptor = FeedServiceDescriptor;
+//# sourceMappingURL=app.api.feeds.js.map

package/lib/app.api/feeds/app.api.feeds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.feeds.js","sourceRoot":"","sources":["../../../src/app.api/feeds/app.api.feeds.ts"],"names":[],"mappings":";;;AAmJA,SAAgB,yBAAyB,CAAC,IAAqB;IAC7D,OAAO;QACL,YAAY,EAAE,iBAAiB;QAC/B,EAAE,EAAE,IAAI,CAAC,EAAY;QACrB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;QAC7C,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,YAAY,EAAE,IAAI,CAAC,YAAiC;KACrD,CAAA;AACH,CAAC;AATD,8DASC;AAMD,SAAgB,qBAAqB,CAAC,IAAiB;IACrD,OAAO;QACL,YAAY,EAAE,aAAa;QAC3B,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,WAAW,EAAE,IAAI,CAAC,WAAqB;QACvC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM;KACpB,CAAA;AACH,CAAC;AATD,sDASC"}

package/lib/app.api/icons/app.api.icons.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+import { PageOf, PagingParameters, UrlResolutionError } from '../../entities/entities.global';
+import { LocalStaticIconStub, StaticIcon, StaticIconId, StaticIconReference } from '../../entities/icons/entities.icons';
+import { EntityNotFoundError, InvalidInputError, MageError, PermissionDeniedError } from '../app.api.errors';
+import { AppRequest, AppRequestContext, AppResponse } from '../app.api.global';
+import { URL } from 'url';
+export interface CreateLocalStaticIconRequest extends AppRequest {
+    iconInfo: LocalStaticIconStub;
+    iconContent: NodeJS.ReadableStream;
+}
+export interface CreateLocalStaticIcon {
+    (req: CreateLocalStaticIconRequest): Promise<AppResponse<StaticIcon, PermissionDeniedError | InvalidInputError>>;
+}
+export interface GetStaticIconRequest extends AppRequest {
+    iconRef: StaticIconReference | {
+        sourceUrl: string;
+    };
+}
+/**
+ * If the request references an icon by ID and the icon does not exist, return
+ * an `EntityNotFoundError`.  If the request is looking up an icon by source
+ * URL and no icon with the source URL exists, return null.
+ */
+export interface GetStaticIcon {
+    (req: GetStaticIconRequest): Promise<AppResponse<StaticIcon | null, PermissionDeniedError | EntityNotFoundError | InvalidInputError>>;
+}
+export interface GetStaticIconContentRequest extends AppRequest {
+    iconId: StaticIconId;
+    cached?: {
+        contentHash?: StaticIcon['contentHash'];
+        contentTimestamp?: StaticIcon['contentTimestamp'];
+        resolvedTimestamp?: StaticIcon['resolvedTimestamp'];
+    };
+}
+export interface StaticIconWithContent {
+    iconInfo: StaticIcon;
+    iconContent: NodeJS.ReadableStream;
+}
+export interface GetStaticIconContent {
+    (req: GetStaticIconContentRequest): Promise<AppResponse<StaticIconWithContent, PermissionDeniedError | EntityNotFoundError | IconSourceUrlFetchError>>;
+}
+export interface ListStaticIconsRequest extends AppRequest {
+    searchText?: string;
+    paging?: Partial<PagingParameters>;
+}
+export interface ListStaticIcons {
+    (req: ListStaticIconsRequest): Promise<AppResponse<PageOf<StaticIcon>, PermissionDeniedError>>;
+}
+export interface StaticIconPermissionService {
+    ensureCreateStaticIconPermission(context: AppRequestContext): Promise<null | PermissionDeniedError>;
+    ensureGetStaticIconPermission(context: AppRequestContext): Promise<null | PermissionDeniedError>;
+}
+export declare const ErrIconSourceUrlFetch: unique symbol;
+export interface IconSourceUrlFetchErrorData {
+    sourceUrl: URL | string;
+    iconId?: StaticIconId;
+}
+export declare type IconSourceUrlFetchError = MageError<typeof ErrIconSourceUrlFetch, IconSourceUrlFetchErrorData>;
+export declare function iconSourceUrlFetchError(sourceUrl: URL | string | UrlResolutionError, iconId: StaticIconId | null | undefined, message?: string): IconSourceUrlFetchError;
+//# sourceMappingURL=app.api.icons.d.ts.map

package/lib/app.api/icons/app.api.icons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.icons.d.ts","sourceRoot":"","sources":["../../../src/app.api/icons/app.api.icons.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAC7F,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACxH,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC5G,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAEzB,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAC,cAAc,CAAA;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,GAAG,EAAE,4BAA4B,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,qBAAqB,GAAG,iBAAiB,CAAC,CAAC,CAAA;CACjH;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,OAAO,EAAE,mBAAmB,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAA;CACrD;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,GAAG,IAAI,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,iBAAiB,CAAC,CAAC,CAAA;CACtI;AAED,MAAM,WAAW,2BAA4B,SAAQ,UAAU;IAC7D,MAAM,EAAE,YAAY,CAAA;IAEpB,MAAM,CAAC,EAAE;QACP,WAAW,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;QACxC,gBAAgB,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAClD,iBAAiB,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAA;KACpD,CAAA;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,UAAU,CAAA;IACpB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAA;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,2BAA2B,GAAG,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,uBAAuB,CAAC,CAAC,CAAA;CACvJ;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IAExD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAA;CAC/F;AAED,MAAM,WAAW,2BAA2B;IAC1C,gCAAgC,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,GAAG,qBAAqB,CAAC,CAAA;IACnG,6BAA6B,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,GAAG,qBAAqB,CAAC,CAAA;CACjG;AAED,eAAO,MAAM,qBAAqB,eAAsC,CAAA;AACxE,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,GAAG,GAAG,MAAM,CAAA;IACvB,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB;AACD,oBAAY,uBAAuB,GAAG,SAAS,CAAC,OAAO,qBAAqB,EAAE,2BAA2B,CAAC,CAAA;AAE1G,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,GAAG,GAAG,MAAM,GAAG,kBAAkB,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAoBxK"}

package/lib/app.api/icons/app.api.icons.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.iconSourceUrlFetchError = exports.ErrIconSourceUrlFetch = void 0;
+const entities_global_1 = require("../../entities/entities.global");
+const app_api_errors_1 = require("../app.api.errors");
+exports.ErrIconSourceUrlFetch = Symbol.for('icon.source_url_fetch');
+function iconSourceUrlFetchError(sourceUrl, iconId, message) {
+    let urlError = null;
+    if (sourceUrl instanceof entities_global_1.UrlResolutionError) {
+        urlError = sourceUrl;
+        sourceUrl = urlError.sourceUrl;
+    }
+    const data = { sourceUrl };
+    if (typeof iconId === 'string') {
+        data.iconId = iconId;
+    }
+    if (!message) {
+        message = `error retrieving content for icon source url ${sourceUrl}`;
+        if (data.iconId) {
+            message = `${message} for icon ${iconId}`;
+        }
+        if (urlError) {
+            message = `${message}: ${urlError.message || 'unknown error'}`;
+        }
+    }
+    return new app_api_errors_1.MageError(exports.ErrIconSourceUrlFetch, data, message);
+}
+exports.iconSourceUrlFetchError = iconSourceUrlFetchError;
+//# sourceMappingURL=app.api.icons.js.map

package/lib/app.api/icons/app.api.icons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.api.icons.js","sourceRoot":"","sources":["../../../src/app.api/icons/app.api.icons.ts"],"names":[],"mappings":";;;AAAA,oEAA6F;AAE7F,sDAA4G;AA4D/F,QAAA,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;AAOxE,SAAgB,uBAAuB,CAAC,SAA4C,EAAE,MAAuC,EAAE,OAAgB;IAC7I,IAAI,QAAQ,GAA8B,IAAI,CAAA;IAC9C,IAAI,SAAS,YAAY,oCAAkB,EAAE;QAC3C,QAAQ,GAAG,SAAS,CAAA;QACpB,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAA;KAC/B;IACD,MAAM,IAAI,GAAgC,EAAE,SAAS,EAAE,CAAA;IACvD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;KACrB;IACD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,GAAG,gDAAgD,SAAS,EAAE,CAAA;QACrE,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,GAAG,GAAG,OAAO,aAAa,MAAM,EAAE,CAAA;SAC1C;QACD,IAAI,QAAQ,EAAE;YACZ,OAAO,GAAG,GAAG,OAAO,KAAK,QAAQ,CAAC,OAAO,IAAI,eAAe,EAAE,CAAA;SAC/D;KACF;IACD,OAAO,IAAI,0BAAS,CAAC,6BAAqB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC5D,CAAC;AApBD,0DAoBC"}