ogm-viewer 0.1.0

package/dist/types/utils/record.d.ts

@@ -0,0 +1,153 @@
+import { LngLatBounds } from 'maplibre-gl';
+import { References } from './references';
+export declare const ENVELOPE_REGEX: RegExp;
+/**
+ * Schema for GeoBlacklight. See https://opengeometadata.github.io/aardvark/aardvarkMetadata.html for more details.
+ */
+export interface GeoBlacklightSchemaAardvark {
+    dct_title_s: string;
+    dct_alternative_sm?: string[];
+    dct_description_sm?: string[];
+    dct_language_sm?: string[];
+    gbl_displayNote_sm?: string[];
+    dct_creator_sm?: string[];
+    dct_publisher_sm?: string[];
+    schema_provider_s?: string;
+    gbl_resourceClass_sm: ('Datasets' | 'Maps' | 'Imagery' | 'Collections' | 'Websites' | 'Web services' | 'Other')[];
+    gbl_resourceType_sm?: string[];
+    dct_subject_sm?: string[];
+    dcat_theme_sm?: string[];
+    dcat_keyword_sm?: string[];
+    dct_temporal_sm?: string[];
+    dct_issued_s?: string;
+    gbl_indexYear_im?: number[];
+    gbl_dateRange_drsim?: string[];
+    dct_spatial_sm?: string[];
+    locn_geometry?: string;
+    dcat_bbox?: string;
+    dcat_centroid?: string;
+    dct_relation_sm?: string[];
+    pcdm_memberOf_sm?: string[];
+    dct_isPartOf_sm?: string[];
+    dct_source_sm?: string[];
+    dct_isVersionOf_sm?: string[];
+    dct_replaces_sm?: string[];
+    dct_isReplacedBy_sm?: string[];
+    dct_rights_sm?: string[];
+    dct_rightsHolder_sm?: string[];
+    dct_license_sm?: string[];
+    dct_accessRights_s: string;
+    dct_format_s?: string;
+    gbl_fileSize_s?: string;
+    gbl_wxsIdentifier_s?: string;
+    dct_references_s?: string;
+    id: string;
+    dct_identifier_sm?: string[];
+    gbl_mdModified_dt?: string;
+    gbl_mdVersion_s: 'Aardvark';
+    gbl_suppressed_b?: boolean;
+    gbl_georeferenced_b?: boolean;
+    [k: string]: unknown;
+}
+/**
+ * These are used to map the keys in the record to more user-friendly names.
+ */
+export declare const OGM_FIELD_NAMES: {
+    id: string;
+    title: string;
+    description: string;
+    resourceType: string;
+    resourceClass: string;
+    accessRights: string;
+    references: string;
+    identifier: string;
+    wxsIdentifier: string;
+    alternativeTitles: string;
+    language: string;
+    displayNotes: string;
+    creators: string;
+    publishers: string;
+    provider: string;
+    themes: string;
+    keywords: string;
+    temporal: string;
+    issued: string;
+    indexYear: string;
+    dateRange: string;
+    spatial: string;
+    geometry: string;
+    bbox: string;
+    centroid: string;
+    relations: string;
+    memberOf: string;
+    isPartOf: string;
+    source: string;
+    isVersionOf: string;
+    replaces: string;
+    isReplacedBy: string;
+    rights: string;
+    rightsHolder: string;
+    license: string;
+    fileSize: string;
+    mdModified: string;
+    suppressed: string;
+    georeferenced: string;
+    subjects: string;
+    mdVersion: string;
+    format: string;
+};
+/**
+ * Class for representing an OGM Aardvark record parsed from JSON data.
+ */
+export declare class OgmRecord {
+    json: GeoBlacklightSchemaAardvark;
+    id: string;
+    title: string;
+    resourceClass: string[];
+    accessRights: string;
+    mdVersion: string;
+    references: References;
+    identifier?: string[];
+    wxsIdentifier?: string;
+    alternativeTitles?: string[];
+    description?: string[];
+    language?: string[];
+    displayNotes?: string[];
+    creators?: string[];
+    publishers?: string[];
+    provider?: string;
+    resourceType?: string[];
+    themes?: string[];
+    keywords?: string[];
+    temporal?: string[];
+    issued?: string;
+    indexYear?: number[];
+    dateRange?: string[];
+    spatial?: string[];
+    geometry?: string;
+    bbox?: string;
+    centroid?: string;
+    relations?: string[];
+    memberOf?: string[];
+    isPartOf?: string[];
+    source?: string[];
+    isVersionOf?: string[];
+    replaces?: string[];
+    isReplacedBy?: string[];
+    rights?: string[];
+    rightsHolder?: string[];
+    license?: string[];
+    fileSize?: string;
+    mdModified?: string;
+    suppressed?: boolean;
+    georeferenced?: boolean;
+    subjects?: string[];
+    format?: string;
+    constructor(data: GeoBlacklightSchemaAardvark);
+    get attribution(): string;
+    get downloadLinks(): {
+        url: string;
+        label: string;
+    }[];
+    getBounds(): LngLatBounds;
+}

package/dist/types/utils/references.d.ts

@@ -0,0 +1,47 @@
+export declare const REFERENCE_URIS: {
+    readonly 'https://github.com/cogeotiff/cog-spec': "COG";
+    readonly 'http://lccn.loc.gov/sh85035852': "Data dictionary";
+    readonly 'http://schema.org/downloadUrl': "Download URL";
+    readonly 'http://geojson.org/geojson-spec.html': "GeoJSON";
+    readonly 'http://schema.org/url': "Layer description";
+    readonly 'http://iiif.io/api/image': "IIIF image";
+    readonly 'http://iiif.io/api/presentation#manifest': "IIIF manifest";
+    readonly 'http://www.opengis.net/cat/csw/csdgm': "FGDC metadata";
+    readonly 'http://www.w3.org/1999/xhtml': "HTML metadata";
+    readonly 'http://www.isotc211.org/schemas/2005/gmd/': "ISO 19139 metadata";
+    readonly 'http://www.loc.gov/mods/v3': "MODS metadata";
+    readonly 'https://oembed.com': "OEmbed";
+    readonly 'https://openindexmaps.org': "Index map";
+    readonly 'https://github.com/protomaps/PMTiles': "PMTiles";
+    readonly 'https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification': "TMS";
+    readonly 'https://github.com/mapbox/tilejson-spec': "TileJSON";
+    readonly 'http://www.opengis.net/def/serviceType/ogc/wcs': "WCS";
+    readonly 'http://www.opengis.net/def/serviceType/ogc/wms': "WMS";
+    readonly 'http://www.opengis.net/def/serviceType/ogc/wfs': "WFS";
+    readonly 'http://www.opengis.net/def/serviceType/ogc/wmts': "WMTS";
+    readonly 'https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames': "XYZ tiles";
+};
+export type ReferenceURI = keyof typeof REFERENCE_URIS;
+export type ReferenceName = (typeof REFERENCE_URIS)[ReferenceURI];
+export type LabelledLinks = {
+    url: string;
+    label: string;
+}[];
+type NonDownloadReferenceURI = Exclude<ReferenceURI, 'http://schema.org/downloadUrl'>;
+type DownloadReference = {
+    'http://schema.org/downloadUrl': string | LabelledLinks;
+};
+export type ReferencesRecord = Partial<{
+    [key in NonDownloadReferenceURI]: string;
+} & DownloadReference>;
+export declare class References {
+    private references;
+    constructor(dct_references_s: string);
+    get wms(): string;
+    get cog(): string;
+    get tms(): string;
+    get xyz(): string;
+    get downloadLinks(): LabelledLinks;
+    get metadataLinks(): LabelledLinks;
+}
+export {};

package/dist/types/utils/sources.d.ts

@@ -0,0 +1,3 @@
+import type { AddLayerObject } from 'maplibre-gl';
+import type { OgmRecord } from './record';
+export declare const getPreviewLayer: (record: OgmRecord) => AddLayerObject;

package/dist/types/utils/utils.d.ts

@@ -0,0 +1 @@
+export declare const setAssetBasePath: () => void;

package/loader/cdn.js

@@ -0,0 +1 @@
+module.exports = require('../dist/cjs/loader.cjs.js');

package/loader/index.cjs.js

@@ -0,0 +1 @@
+module.exports = require('../dist/cjs/loader.cjs.js');

package/loader/index.d.ts

@@ -0,0 +1,24 @@
+export * from '../dist/types/components';
+export interface CustomElementsDefineOptions {
+  exclude?: string[];
+  resourcesUrl?: string;
+  syncQueue?: boolean;
+  jmp?: (c: Function) => any;
+  raf?: (c: FrameRequestCallback) => number;
+  ael?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+  rel?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+}
+export declare function defineCustomElements(win?: Window, opts?: CustomElementsDefineOptions): void;
+/**
+ * @deprecated
+ */
+export declare function applyPolyfills(): Promise<void>;
+
+/**
+ * Used to specify a nonce value that corresponds with an application's CSP.
+ * When set, the nonce will be added to all dynamically created script and style tags at runtime.
+ * Alternatively, the nonce value can be set on a meta tag in the DOM head
+ * (<meta name="csp-nonce" content="{ nonce value here }" />) which
+ * will result in the same behavior.
+ */
+export declare function setNonce(nonce: string): void;

package/loader/index.es2017.js

@@ -0,0 +1 @@
+export * from '../dist/esm/loader.js';

package/loader/index.js

@@ -0,0 +1,2 @@
+(function(){if("undefined"!==typeof window&&void 0!==window.Reflect&&void 0!==window.customElements){var a=HTMLElement;window.HTMLElement=function(){return Reflect.construct(a,[],this.constructor)};HTMLElement.prototype=a.prototype;HTMLElement.prototype.constructor=HTMLElement;Object.setPrototypeOf(HTMLElement,a)}})();
+export * from '../dist/esm/loader.js';

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "ogm-viewer",
+  "version": "0.1.0",
+  "description": "Stencil Component Starter",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "collection": "dist/collection/collection-manifest.json",
+  "collection:main": "dist/collection/index.js",
+  "unpkg": "dist/ogm-viewer/ogm-viewer.esm.js",
+  "exports": {
+    ".": {
+      "import": "./dist/ogm-viewer/ogm-viewer.esm.js",
+      "require": "./dist/ogm-viewer/ogm-viewer.cjs.js"
+    },
+    "./loader": {
+      "import": "./loader/index.js",
+      "require": "./loader/index.cjs",
+      "types": "./loader/index.d.ts"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stenciljs/component-starter.git"
+  },
+  "files": [
+    "dist/",
+    "loader/"
+  ],
+  "scripts": {
+    "build": "stencil build",
+    "start": "stencil build --dev --watch --serve",
+    "test": "stencil test --spec --e2e",
+    "test.watch": "stencil test --spec --e2e --watchAll",
+    "generate": "stencil generate",
+    "lint": "prettier --check ."
+  },
+  "devDependencies": {
+    "@stencil/core": "^4.27.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.5",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
+    "prettier": "^3.6.2",
+    "puppeteer": "^24.3.0"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@geomatico/maplibre-cog-protocol": "^0.5.0",
+    "@shoelace-style/shoelace": "^2.20.1",
+    "d3-scale": "^4.0.2",
+    "maplibre-gl": "^5.6.0"
+  }
+}

package/readme.md

@@ -0,0 +1,4 @@
+[![CI](https://github.com/OpenGeoMetadata/ogm-viewer/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenGeoMetadata/ogm-viewer/actions/workflows/ci.yml)
+[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
+
+# Coming Soon!