@ngageoint/mage.service 6.2.2

package/lib/entities/icons/entities.icons.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="node" />
+import { URL } from 'url';
+import { PageOf, PagingParameters, UrlResolutionError } from '../entities.global';
+export declare type StaticIconStub = Omit<StaticIcon, 'id' | 'registeredTimestamp' | 'resolvedTimestamp'>;
+export interface ImageSize {
+    width: number;
+    height: number;
+}
+/**
+ * The reason for the 'static' qualifier of `StaticIcon` is to distinguish
+ * that the icon image is not dynamically generated and so is subject to
+ * caching.  Other types of icons, such as the [Joint Military Symbology](https://www.jcs.mil/Portals/36/Documents/Doctrine/Other_Pubs/ms_2525d.pdf)
+ * may be dynamically generated based on the attributes of the feature the icon
+ * represents.
+ */
+export interface StaticIcon {
+    /**
+     * The source URL of an icon is a persistent, cache-friendly URL that exists
+     * outside the URL namespace of a particular MAGE server.  For example, this
+     * could be an HTTP URL that MAGE can use to retrieve and cache the icon.
+     */
+    sourceUrl: URL;
+    id: StaticIconId;
+    registeredTimestamp: number;
+    /**
+     * The epoch timestamp that the icon's content was last successfully fetched
+     * and stored (if necessary) from its source URL.
+     */
+    resolvedTimestamp?: number;
+    imageType?: 'raster' | 'vector';
+    /**
+     * The icons's media type is a standard [IANA media/MIME](https://www.iana.org/assignments/media-types/media-types.xhtml)
+     * type strings, such as `image/jpeg`.
+     */
+    mediaType?: string;
+    /**
+     * The size in pixels is the width and height of the icon's image canvas.
+     */
+    sizePixels?: ImageSize;
+    sizeBytes?: number;
+    contentHash?: string;
+    /**
+     * The intention of content timestamp is to be a last-modified timestamp of
+     * the source content, such as the timestamp extracted from the
+     * `Last-Modified` header of an icon fetched from a remote HTTP server.
+     */
+    contentTimestamp?: number;
+    title?: string;
+    summary?: string;
+    /**
+     * The icon's file name is the original file name of an uploaded icon, and/or
+     * the default file name provided to download the icon.
+     */
+    fileName?: string;
+    tags?: string[];
+}
+export declare type LocalStaticIconStub = Omit<StaticIconStub, 'sourceUrl' | 'title'> & Required<Pick<StaticIcon, 'title'>>;
+export declare type StaticIconId = string;
+export declare enum StaticIconImportFetch {
+    /**
+     * Immediately fetch and store the icon content from the source URL and wait
+     * for the fetch to complete.
+     */
+    EagerAwait = "StaticIconFetch.eagerAwait",
+    /**
+     * Immediately fetch and store the icon content from the source URL, but do
+     * not serially wait for the fetch to complete.
+     */
+    Eager = "StaticIconFetch.eager",
+    /**
+     * Defer fetching the icon content from the source URL until some process
+     * explictly requests a fetch at some point in the future, such as a client
+     * requests the icon content by its internal ID.
+     */
+    Lazy = "StaticIconFetch.lazy"
+}
+export interface StaticIconRepository {
+    findOrImportBySourceUrl(stub: StaticIconStub | URL, fetch?: StaticIconImportFetch): Promise<StaticIcon | UrlResolutionError>;
+    createLocal(stub: LocalStaticIconStub, content: NodeJS.ReadableStream): Promise<StaticIcon>;
+    findByReference(ref: StaticIconReference): Promise<StaticIcon | null>;
+    find(paging?: PagingParameters): Promise<PageOf<StaticIcon>>;
+    /**
+     * Load the image content for the given icon ID.  If the given ID does not
+     * exist in the database, return null.  If no URL scheme can resolve the
+     * icon's source URL, return a `UrlResolutionError`.  If an icon with the
+     * given ID exists but its content is not yet resolved, attempt to fetch
+     * and store the content.  If an error occurs fetching the content, return
+     * a `UrlResolutionError`.
+     * @param id
+     */
+    loadContent(id: StaticIconId): Promise<[StaticIcon, NodeJS.ReadableStream] | null | UrlResolutionError>;
+}
+export interface RegisteredStaticIconReference {
+    id: StaticIconId;
+    sourceUrl?: never;
+}
+export interface SourceUrlStaticIconReference {
+    sourceUrl: URL;
+    id?: never;
+}
+export declare type StaticIconReference = RegisteredStaticIconReference | SourceUrlStaticIconReference;
+export interface StaticIconContentStore {
+    putContent(icon: StaticIcon, content: NodeJS.ReadableStream): Promise<void>;
+    loadContent(id: StaticIconId): Promise<NodeJS.ReadableStream | null>;
+}
+//# sourceMappingURL=entities.icons.d.ts.map

package/lib/entities/icons/entities.icons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.icons.d.ts","sourceRoot":"","sources":["../../../src/entities/icons/entities.icons.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AACzB,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAGjF,oBAAY,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,qBAAqB,GAAG,mBAAmB,CAAC,CAAA;AAEjG,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,SAAS,EAAE,GAAG,CAAA;IACd,EAAE,EAAE,YAAY,CAAA;IAChB,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,oBAAY,mBAAmB,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;AAMnH,oBAAY,YAAY,GAAG,MAAM,CAAA;AAEjC,oBAAY,qBAAqB;IAC/B;;;OAGG;IACH,UAAU,+BAA+B;IACzC;;;OAGG;IACH,KAAK,0BAA0B;IAC/B;;;;OAIG;IACH,IAAI,yBAAyB;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,uBAAuB,CAAC,IAAI,EAAE,cAAc,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,GAAG,kBAAkB,CAAC,CAAA;IAC5H,WAAW,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAC3F,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAA;IACrE,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC5D;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,GAAG,IAAI,GAAG,kBAAkB,CAAC,CAAA;CACxG;AAED,MAAM,WAAW,6BAA6B;IAC5C,EAAE,EAAE,YAAY,CAAA;IAChB,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,GAAG,CAAA;IACd,EAAE,CAAC,EAAE,KAAK,CAAA;CACX;AAED,oBAAY,mBAAmB,GAAG,6BAA6B,GAAG,4BAA4B,CAAA;AAE9F,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3E,WAAW,CAAC,EAAE,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;CACrE"}

package/lib/entities/icons/entities.icons.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticIconImportFetch = void 0;
+const iconIsResolved = (icon) => {
+    return typeof icon.contentHash === 'string' && typeof icon.contentTimestamp === 'number';
+};
+var StaticIconImportFetch;
+(function (StaticIconImportFetch) {
+    /**
+     * Immediately fetch and store the icon content from the source URL and wait
+     * for the fetch to complete.
+     */
+    StaticIconImportFetch["EagerAwait"] = "StaticIconFetch.eagerAwait";
+    /**
+     * Immediately fetch and store the icon content from the source URL, but do
+     * not serially wait for the fetch to complete.
+     */
+    StaticIconImportFetch["Eager"] = "StaticIconFetch.eager";
+    /**
+     * Defer fetching the icon content from the source URL until some process
+     * explictly requests a fetch at some point in the future, such as a client
+     * requests the icon content by its internal ID.
+     */
+    StaticIconImportFetch["Lazy"] = "StaticIconFetch.lazy";
+})(StaticIconImportFetch = exports.StaticIconImportFetch || (exports.StaticIconImportFetch = {}));
+//# sourceMappingURL=entities.icons.js.map

package/lib/entities/icons/entities.icons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.icons.js","sourceRoot":"","sources":["../../../src/entities/icons/entities.icons.ts"],"names":[],"mappings":";;;AA8DA,MAAM,cAAc,GAAG,CAAC,IAAgB,EAAW,EAAE;IACnD,OAAO,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,gBAAgB,KAAK,QAAQ,CAAA;AAC1F,CAAC,CAAA;AAID,IAAY,qBAiBX;AAjBD,WAAY,qBAAqB;IAC/B;;;OAGG;IACH,kEAAyC,CAAA;IACzC;;;OAGG;IACH,wDAA+B,CAAA;IAC/B;;;;OAIG;IACH,sDAA6B,CAAA;AAC/B,CAAC,EAjBW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAiBhC"}