@internetarchive/ia-item-navigator 0.0.0 → 0.0.2

package/demo/demo-item-md.json

@@ -1,247 +0,0 @@
-{
-  "created": 1623165950,
-  "d1": "ia601302.us.archive.org",
-  "d2": "ia801302.us.archive.org",
-  "dir": "/34/items/EWReidquotsNurs00EWReH",
-  "files": [
-    {
-      "name": "EWReidquotsNurs00EWReH.djvu",
-      "source": "derivative",
-      "format": "DjVu",
-      "original": "EWReidquotsNurs00EWReH_djvu.xml",
-      "mtime": "1441867975",
-      "size": "4755873",
-      "md5": "acea0c4fa2c3649c197b9d4b96b9c90f",
-      "crc32": "16d30fc2",
-      "sha1": "1a5ea03e0ac400f060e271fdaabcd690ccb7d6d9"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH.gif",
-      "source": "derivative",
-      "format": "Animated GIF",
-      "original": "EWReidquotsNurs00EWReH_jp2.zip",
-      "mtime": "1441867193",
-      "size": "285494",
-      "md5": "f567064d9df272a6be24ffa342818f48",
-      "crc32": "d32159c0",
-      "sha1": "a403228363e9331b230957c3a3fec9167e06608e"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH.pdf",
-      "source": "derivative",
-      "format": "Text PDF",
-      "original": "EWReidquotsNurs00EWReH_djvu.xml",
-      "mtime": "1441868228",
-      "size": "7292656",
-      "md5": "037a6cf7afc2c9b3e6c1a7e92339f199",
-      "crc32": "c0f9025e",
-      "sha1": "edf129d57ac2ba1272fe485b4a696d48d6d5ee44"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_abbyy.gz",
-      "source": "derivative",
-      "format": "Abbyy GZ",
-      "original": "EWReidquotsNurs00EWReH_jp2.zip",
-      "mtime": "1441867680",
-      "size": "4356879",
-      "md5": "7705528ebae28de1d6c6296e9d0a8563",
-      "crc32": "7a1b5de1",
-      "sha1": "b1875aec62a8663a3d4ee18a52e38ff3e482f192"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_archive.torrent",
-      "source": "metadata",
-      "btih": "faae87b4be4a39ff9ca0f6d1690a34e314982801",
-      "mtime": "1608789321",
-      "size": "6237",
-      "md5": "a3afa0ce01bcdc54f208e56731a70669",
-      "crc32": "b790d98e",
-      "sha1": "ce08fce64f870e19e88d02ef1e476b12435eca0c",
-      "format": "Archive BitTorrent"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_bhlmets.xml",
-      "source": "original",
-      "mtime": "1471594158",
-      "size": "43346",
-      "format": "Biodiversity Heritage Library METS",
-      "md5": "ee4d6874ce88e762c383ce3e3143559d",
-      "crc32": "82911e3c",
-      "sha1": "5e0253aea752287ac4eb5eddefd7e06273b2fd2c"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_bw.pdf",
-      "source": "derivative",
-      "format": "Grayscale PDF",
-      "original": "EWReidquotsNurs00EWReH_djvu.xml",
-      "mtime": "1441868612",
-      "size": "8556119",
-      "md5": "a94252edb7d0d83573811e9037d40b35",
-      "crc32": "f82d4fb9",
-      "sha1": "9863750f7109da08a056e1166b80c1265c4781d7"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_dc.xml",
-      "source": "original",
-      "format": "Dublin Core",
-      "mtime": "1441867179",
-      "size": "1016",
-      "md5": "3cd7cd1cd217a8345258b75bafb9c209",
-      "crc32": "64cc8e64",
-      "sha1": "fa37f7d86bc3b49b605035d45f9caf1c5725641c"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_djvu.txt",
-      "source": "derivative",
-      "format": "DjVuTXT",
-      "original": "EWReidquotsNurs00EWReH.djvu",
-      "mtime": "1441868624",
-      "size": "290313",
-      "md5": "6cf51da4b3e17981c56539830c80300b",
-      "crc32": "f08f35ee",
-      "sha1": "6044c0eff144a116b7fc12e23a29d774fbf8a7eb"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_djvu.xml",
-      "source": "derivative",
-      "format": "Djvu XML",
-      "original": "EWReidquotsNurs00EWReH_abbyy.gz",
-      "mtime": "1441867758",
-      "size": "2776587",
-      "md5": "084f27735670ad1fb831d7b8e123c70d",
-      "crc32": "cdc8a083",
-      "sha1": "fec186c4d9137f2da0defd0d394f840d2c8b6282"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_files.xml",
-      "source": "original",
-      "format": "Metadata",
-      "md5": "2b38819a7fd448e4a75ab607547fcebd"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_jp2.zip",
-      "source": "original",
-      "mtime": "1441867164",
-      "size": "27478796",
-      "md5": "552112543a4d8df1707bcc8fb163f93c",
-      "crc32": "104860e5",
-      "sha1": "19a0a226c36f95b85b6f8bfe32853e72ce4e92a2",
-      "format": "Single Page Processed JP2 ZIP"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_marc.xml",
-      "source": "original",
-      "mtime": "1441867158",
-      "size": "3952",
-      "md5": "8e7d73ab2f836c4fc6e7640d48648a77",
-      "crc32": "27703ddb",
-      "sha1": "3a2bf3f2648dbd58505fa51ea003b6f1749ba32e",
-      "format": "MARC"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_meta.sqlite",
-      "source": "original",
-      "mtime": "1471594169",
-      "size": "11264",
-      "format": "Metadata",
-      "md5": "839bf51334ae43c9d21e4ee882f3ff59",
-      "crc32": "14d1db51",
-      "sha1": "b176fbaf48c809b87edab208f4e1d3949efaef3e"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_meta.xml",
-      "source": "original",
-      "mtime": "1608789319",
-      "size": "2272",
-      "format": "Metadata",
-      "md5": "11c0f2e6a01935290009ee193472255f",
-      "crc32": "b9d893d7",
-      "sha1": "695a8ff18605b59e71ace14b08f5223716d7c335"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_names.xml",
-      "source": "original",
-      "mtime": "1442302590",
-      "size": "57169",
-      "md5": "51b563e7793a5d52e3c3805ba939fc61",
-      "crc32": "6a65b15a",
-      "sha1": "f5ac21dccc3c196f2354d0892d943f5394a6f6f9",
-      "format": "Name Metadata"
-    },
-    {
-      "name": "EWReidquotsNurs00EWReH_scandata.xml",
-      "source": "original",
-      "mtime": "1441867148",
-      "size": "45352",
-      "md5": "9b938596c832f6316fa08592c674dec1",
-      "crc32": "1e2e2496",
-      "sha1": "d23268b6847d9d2b14af1ff9f08b5026fa8b319c",
-      "format": "Scandata"
-    },
-    {
-      "name": "__ia_thumb.jpg",
-      "source": "original",
-      "mtime": "1608789320",
-      "size": "25320",
-      "md5": "d9c7a1b6f92445cb27d1f1a72ce68fbd",
-      "crc32": "2b0dffc3",
-      "sha1": "f7d1e9f60857bf9daaeabf18d9b94095ba044dc8",
-      "format": "Item Tile",
-      "rotation": "0"
-    }
-  ],
-  "files_count": 18,
-  "item_last_updated": 1608789321,
-  "item_size": 55988645,
-  "metadata": {
-    "identifier": "EWReidquotsNurs00EWReH",
-    "abstract": "A collection of nursery and seed catalogs published by E.W. Reid"s Nurseries (Bridgeport; Upland, Ohio; also known as E.W. Reid (Firm)) from 1890-1901; part of the Ethel Z. Bailey Horticultural Catalogue Collection.",
-    "call_number": "CUbiodiversity31924108762588",
-    "call-number": "CUbiodiversity31924108762588",
-    "contributor": "Cornell University Library",
-    "creator": [
-      "E.W. Reid's Nurseries",
-      "Liberty Hyde Bailey Hortorium. Ethel Z. Bailey Horticultural Catalogue Collection"
-    ],
-    "curation": "[curator]biodiversitylibrary.org[/curator][date]20150910023608[/date][state]approved[/state]",
-    "date": "1890",
-    "genre": "catalog",
-    "identifier-bib": "CUbiodiversity31924108762588",
-    "language": "eng",
-    "mediatype": "texts",
-    "possible-copyright-status": "Public domain. The BHL considers that this work is no longer under copyright protection.",
-    "sponsor": "L.H. Bailey Hortorium; Mann Library; IMLS",
-    "title": "[E.W. Reid's Nurseries materials]",
-    "volume": "1897 Spring",
-    "year": "1890",
-    "collection": [
-      "cornell",
-      "biodiversity",
-      "seedcatalogs"
-    ],
-    "subject": [
-      "Seeds",
-      "Nurseries (Horticulture)",
-      "E.W. Reid's Nurseries"
-    ],
-    "publicdate": "2015-09-10 06:39:09",
-    "uploader": "mikecook@cornell.edu",
-    "addeddate": "2015-09-10 06:39:09",
-    "description": "A collection of nursery and seed catalogs published by E.W. Reid's Nurseries (Bridgeport; Upland, Ohio; also known as E.W. Reid (Firm)) from 1890-1901; part of the Ethel Z. Bailey Horticultural Catalogue Collection",
-    "ppi": "300",
-    "imagecount": "74",
-    "foldoutcount": "0",
-    "identifier-access": "http://archive.org/details/EWReidquotsNurs00EWReH",
-    "identifier-ark": "ark:/13960/t9z06rw3f",
-    "ocr": "ABBYY FineReader 11.0",
-    "repub_state": "4",
-    "backup_location": "ia905501_8",
-    "filesxml": "Thu Dec 24 5:55:19 UTC 2020"
-  },
-  "server": "ia801302.us.archive.org",
-  "uniq": 2094171797,
-  "workable_servers": [
-    "ia801302.us.archive.org",
-    "ia601302.us.archive.org"
-  ]
-}

package/src/interfaces/nav-controller-interface.ts

@@ -1,18 +0,0 @@
-import { LitElement } from 'lit-element';
-import { MetadataResponse } from '@internetarchive/search-service';
-import { IntMenuShortcut } from './menu-interfaces';
-
-export interface IntNavController extends LitElement {
-  baseHost: string;
-  itemMD: MetadataResponse;
-  menuProviders: object;
-  menuShortcuts: IntMenuShortcut[];
-  sideMenuOpen: boolean;
-
-  emitLoadingStatusUpdate: (loaded: boolean) => void;
-
-  addMenuShortcut: (menuId: string) => void;
-  removeMenuShortcut: (menuId: string) => void;
-  sortMenuShortcuts: () => void;
-  emitMenuShortcutsUpdated: () => void;
-}

package/src/item-inspector/files-by-type/files-by-type-provider.ts

@@ -1,41 +0,0 @@
-import { html, TemplateResult } from 'lit-element';
-
-import './ia-files-by-type';
-import '@internetarchive/icon-share/icon-share';
-import {
-  IntMenuProvider,
-  IntProviderArgs,
-} from '../../interfaces/menu-interfaces';
-
-export class FilesByTypeProvider implements IntMenuProvider {
-  item: any = null;
-
-  baseHost: string = 'https://archive.org';
-
-  icon: TemplateResult = html`<ia-icon-share
-    style="width: var(--iconWidth); height: var(--iconHeight);"
-  ></ia-icon-share>`;
-
-  id: string = 'filesByType';
-
-  label: string = 'Files by type';
-
-  component: TemplateResult | null = null;
-
-  subPrefix: string = '';
-
-  constructor(shareArgs: IntProviderArgs) {
-    const { item, baseHost, subPrefix = '' } = shareArgs;
-    const { title = '' } = item.metadata;
-
-    this.item = item;
-    this.baseHost = baseHost;
-    this.subPrefix = subPrefix;
-
-    this.component = html`<ia-files-by-type
-      .item=${this.item}
-      .description="${title}"
-      .baseHost="${this.baseHost}"
-    ></ia-files-by-type>`;
-  }
-}

package/src/item-inspector/files-by-type/ia-files-by-type.ts

@@ -1,84 +0,0 @@
-import { MetadataResponse, File } from '@internetarchive/search-service';
-import { html, customElement, LitElement, property } from 'lit-element';
-
-interface CollapsedFileInt extends File {
-  [menuId: string]: any;
-  derivatives: [];
-}
-
-@customElement('ia-files-by-type')
-export default class IaFilesByType extends LitElement {
-  @property({ type: Object }) item: MetadataResponse = {} as MetadataResponse;
-
-  @property({ type: Array }) archivalArtifacts: File[] = [];
-
-  @property({ type: Array }) collapsedFiles: CollapsedFileInt[] = [];
-
-  firstUpdated() {
-    this.collapseFiles();
-  }
-
-  render() {
-    return html`
-      <div>
-        <p>there are ${this.collapsedFiles.length} original files</p>
-
-        <p>there are ${this.archivalArtifacts.length} archival artifacts</p>
-
-        <p></p>
-      </div>
-    `;
-  }
-
-  collapseFiles() {
-    const { files = [] } = this?.item as MetadataResponse;
-
-    const archivalArtifacts: File[] = [];
-    const origDir: any = {};
-
-    files.forEach(fi => {
-      const { format, source, name, original = '' } = fi as File;
-      if (
-        format.toLowerCase() === 'metadata' ||
-        format.toLowerCase() === 'item tile'
-      ) {
-        archivalArtifacts.push(fi);
-        return;
-      }
-
-      let origEntry: any = {};
-      if (source === 'original') {
-        origEntry = origDir[name];
-        if (!origEntry) {
-          // add new
-          origDir[name] = { ...fi, derivatives: [] } as CollapsedFileInt;
-          origEntry = origDir[name];
-        } else {
-          // update
-          const merged = { ...origEntry, ...fi };
-          origDir[name] = merged;
-        }
-        return;
-      }
-
-      if (source === 'derivative') {
-        const keyToFile = original || '';
-        origEntry = origDir[keyToFile];
-        if (!origEntry && original) {
-          // add new
-          const fileFrame = { derivatives: [] } as CollapsedFileInt;
-          origEntry = fileFrame;
-          origEntry?.derivatives.push(fi);
-          origDir[keyToFile] = origEntry;
-          origEntry = origDir[keyToFile];
-        }
-        origEntry?.derivatives.push(fi);
-      }
-    });
-
-    this.archivalArtifacts = archivalArtifacts;
-    this.collapsedFiles = Object.keys(origDir).map(
-      (fileName: string) => origDir[fileName]
-    );
-  }
-}

package/src/item-inspector/item-inspector.ts

@@ -1,202 +0,0 @@
-/* eslint-disable no-console */
-import {
-  css,
-  html,
-  LitElement,
-  customElement,
-  property,
-  state,
-} from 'lit-element';
-// import { nothing, TemplateResult } from 'lit-html';
-import { MetadataResponse } from '@internetarchive/search-service';
-import { IntNavController } from '../interfaces/nav-controller-interface';
-import {
-  IntMenuShortcut,
-  IntMenuProvider,
-} from '../interfaces/menu-interfaces';
-
-import { ShareProvider } from './share-provider';
-import { FilesByTypeProvider } from './files-by-type/files-by-type-provider';
-
-// eslint-disable-next-line no-shadow
-enum ItemInspectorEvents {
-  menuUpdated = 'menuUpdated',
-  updateSideMenu = 'updateSideMenu',
-  PostInit = 'PostInit',
-  ViewportInFullScreen = 'ViewportInFullScreen',
-}
-
-interface menuProvidersInt {
-  [menuId: string]: IntMenuProvider;
-}
-
-@customElement('ia-item-inspector')
-export class IaItemInspector extends LitElement implements IntNavController {
-  @property({ type: Object }) itemMD: MetadataResponse = {} as MetadataResponse;
-
-  @property({ type: String }) baseHost = 'https://archive.org';
-
-  @property({ type: Object }) menuProviders: menuProvidersInt = {};
-
-  @property({ type: Array }) menuShortcuts: IntMenuShortcut[] = [];
-
-  @property({ type: Array }) shortcutOrder: string[] = ['filesByType'];
-
-  @property({ type: Boolean }) sideMenuOpen = false;
-
-  @state() fileCount: number = 0;
-
-  @state() loaded: boolean = false;
-
-  firstUpdated() {
-    this.loaded = true;
-  }
-
-  updated(changed: any) {
-    if (changed.has('loaded')) {
-      this.emitLoadingStatusUpdate(this.loaded);
-    }
-
-    if (changed.has('itemMD') && this.itemMD) {
-      this.parseItemInfo();
-      this.setMenu();
-    }
-
-    if (changed.has('menuProviders') || changed.has('menuShortcuts')) {
-      this.updateMenuContents();
-    }
-  }
-
-  render() {
-    const { identifier = '' } = this.itemMD?.metadata || {};
-    return html`
-      <section>
-        <div>
-          <h2>${identifier}</h2>
-        </div>
-        <img src=${this.imageUrl} alt=${`${identifier} thumbnail`} />
-      </section>
-    `;
-  }
-
-  setMenu() {
-    const menuProviders = {
-      share: new ShareProvider({
-        item: this.itemMD,
-        baseHost: this.baseHost,
-        subPrefix: '',
-      }),
-      filesByType: new FilesByTypeProvider({
-        item: this.itemMD,
-        baseHost: this.baseHost,
-        subPrefix: '',
-      }),
-    };
-
-    this.menuProviders = menuProviders;
-
-    this.addMenuShortcut('filesByType');
-  }
-
-  addMenuShortcut(menuId: keyof menuProvidersInt) {
-    if (this.menuShortcuts.find(m => m.id === menuId)) {
-      return;
-    }
-
-    const shortcut = this.menuProviders[menuId];
-    this.menuShortcuts.push(shortcut);
-    this.sortMenuShortcuts();
-    this.emitMenuShortcutsUpdated();
-  }
-
-  sortMenuShortcuts() {
-    const sorted = this.shortcutOrder.reduce(
-      (shortcuts: IntMenuShortcut[], id): IntMenuShortcut[] => {
-        const menu = this.menuShortcuts.find(
-          m => m.id === id
-        ) as IntMenuShortcut;
-
-        let allShortcuts: IntMenuShortcut[] = [...shortcuts];
-        if (menu) {
-          const newShortcut = [menu];
-          allShortcuts = [...shortcuts, ...newShortcut];
-        }
-        return allShortcuts;
-      },
-      []
-    );
-
-    this.menuShortcuts = sorted;
-  }
-
-  emitMenuShortcutsUpdated() {
-    const event = new CustomEvent('menuShortcutsUpdated', {
-      detail: this.menuShortcuts,
-    });
-    this.dispatchEvent(event);
-  }
-
-  removeMenuShortcut(menuId: string) {
-    this.menuShortcuts = this.menuShortcuts.filter(m => m.id !== menuId);
-    this.emitMenuShortcutsUpdated();
-  }
-
-  updateMenuContents() {
-    const { share, filesByType } = this.menuProviders;
-    const availableMenus = [filesByType, share].filter(menu => !!menu);
-
-    const event = new CustomEvent(ItemInspectorEvents.menuUpdated, {
-      detail: availableMenus,
-    });
-
-    this.dispatchEvent(event);
-  }
-
-  emitLoadingStatusUpdate(loaded: boolean) {
-    const event = new CustomEvent('loadingStateUpdated', {
-      detail: { loaded },
-    });
-    this.dispatchEvent(event);
-  }
-
-  parseItemInfo() {
-    this.fileCount = this.itemMD?.files?.length || 0;
-  }
-
-  get imageUrl() {
-    const { metadata = {} } = this.itemMD;
-    const url = `${this.baseHost}/download/${metadata?.identifier}/__ia_thumb.jpg`;
-    return url;
-  }
-
-  static get styles() {
-    const main = css`
-      :host {
-        display: block;
-        width: 100%;
-        margin: 0 auto;
-        position: relative;
-        overflow: hidden;
-        display: block;
-      }
-
-      :host,
-      section {
-        min-height: inherit;
-        height: inherit;
-      }
-
-      section {
-        margin: auto;
-        width: 100%;
-        border: 1px solid;
-        text-align: center;
-      }
-
-      img {
-        border: 1px solid var(--primaryTextColor, #fff);
-      }
-    `;
-    return [main];
-  }
-}

package/src/item-inspector/share-provider.ts

@@ -1,51 +0,0 @@
-import { html, TemplateResult } from 'lit-element';
-
-import '@internetarchive/ia-sharing-options';
-import '@internetarchive/icon-share/icon-share';
-import {
-  IntMenuProvider,
-  IntProviderArgs,
-} from '../interfaces/menu-interfaces';
-
-export class ShareProvider implements IntMenuProvider {
-  item: any = null;
-
-  baseHost: string = 'https://archive.org';
-
-  icon: TemplateResult = html`<ia-icon-share
-    style="width: var(--iconWidth); height: var(--iconHeight);"
-  ></ia-icon-share>`;
-
-  id: string = 'share';
-
-  label: string = 'Share this item';
-
-  component: TemplateResult | null = null;
-
-  subPrefix: string = '';
-
-  encodedSubPrefix: string = '';
-
-  constructor(shareArgs: IntProviderArgs) {
-    const { item, baseHost, subPrefix = '' } = shareArgs;
-    const { identifier = '', creator = '', title = '' } = item.metadata || {};
-    const encodedSubPrefix = encodeURIComponent(subPrefix);
-    const urlIdentifier =
-      subPrefix && subPrefix !== identifier
-        ? `${identifier}/${encodedSubPrefix}`
-        : identifier;
-
-    this.item = item;
-    this.baseHost = baseHost;
-    this.subPrefix = subPrefix;
-    this.encodedSubPrefix = encodedSubPrefix;
-
-    this.component = html`<ia-sharing-options
-      identifier=${urlIdentifier}
-      type="item"
-      creator="${creator}"
-      description="${title}"
-      baseHost="${this.baseHost}"
-    ></ia-sharing-options>`;
-  }
-}