Merge upstream a623911 into phase-10 (AD01)

Author: Sam-Bolling

app/.vitepress/theme/custom.css

@@ -83,3 +83,15 @@ a.VPSocialLink.no-icon svg {
 .pico select:focus {
   border-color: var(--vp-c-brand-1);
 }
+
+.vp-doc table {
+  display: table;
+  table-layout: auto;
+  width: 100%;
+}
+
+.vp-doc table th,
+.vp-doc table td {
+  min-width: 140px;
+  max-width: 300px;
+}

app/api-utils.js

@@ -51,6 +51,17 @@ export function formatTypeToString(typeObj) {
     const returnType = typeObj.declaration?.signatures?.[0]?.type;
     return `() => ${formatTypeToString(returnType)}`;
   }
+  if (
+    typeObj.type === 'reflection' &&
+    typeObj.declaration?.kind & 65536 // ReflectionKind.TypeLiteral
+  ) {
+    const properties = typeObj.declaration?.children
+      ?.map((propEl) => {
+        return `${propEl.name}: ${formatTypeToString(propEl.type)}`;
+      })
+      .join(', ');
+    return `{ ${properties} }`;
+  }
   if (typeObj.type === 'reference') {
     switch (typeObj.name) {
       case 'Record':
@@ -62,9 +73,12 @@ export function formatTypeToString(typeObj) {
       case 'Error':
         return `[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)`;
       case 'Promise':
-        return `[Promise](https://developer.mozilla.org/en-US/docs/Web/API/Promise)<${formatTypeToString(
+        // we include a zero-width space after the opening < have more readable line breaks (https://en.wikipedia.org/wiki/Zero-width_space)
+        return `[Promise](https://developer.mozilla.org/en-US/docs/Web/API/Promise)&lt;<wbr>${formatTypeToString(
           typeObj.typeArguments[0],
-        )}&gt;`;
+        )}<wbr>&gt;`;
+      case 'Omit':
+        return formatTypeToString(typeObj.typeArguments[0]);
     }
     const ref = API.children.find((el) => el.id === typeObj.target);
     if (ref) {

app/api.data.js

@@ -32,39 +32,64 @@ function processClass(apiElement, importPath) {
   );
   const properties = apiElement.children.filter(
     (item) =>
-      item.kind & 262144 /* ReflectionKind.Accessor */ &&
+      (item.kind & 262144 /* ReflectionKind.Accessor */ ||
+        item.kind & 1024) /* ReflectionKind.Property */ &&
       !item.flags?.isInherited,
   );
   const methods = apiElement.children.filter(
     (item) =>
-      item.kind & 2048 /* ReflectionKind.Method */ && !item.flags?.isInherited,
+      item.kind & 2048 /* ReflectionKind.Method */ &&
+      !item.flags?.isInherited &&
+      !item.flags?.isStatic,
   );
+  const staticMethods = apiElement.children
+    .filter(
+      (item) =>
+        item.kind & 2048 /* ReflectionKind.Method */ &&
+        !item.flags?.isInherited &&
+        item.flags?.isStatic,
+    )
+    .map((methodElement) => ({
+      ...methodElement,
+      name: `${apiElement.name}.${methodElement.name}`,
+    }));
 
   return {
     name: apiElement.name,
     descriptionHtml: markdown(getDescription(apiElement)),
     importHtml: markdown(`\`\`\`js
 import { ${apiElement.name} } from '${importPath}'
 \`\`\``),
-    constructorSignature: markdownInline(
-      formatConstructorToString(apiElement, constructorElement),
-    ),
-    constructor: processFunction(constructorElement, importPath),
-    constructorDescriptionHtml: markdown(getDescription(constructorElement)),
+    constructorSignature: constructorElement
+      ? markdownInline(
+          formatConstructorToString(apiElement, constructorElement),
+        )
+      : null,
+    constructor: constructorElement
+      ? processFunction(constructorElement, importPath)
+      : null,
+    constructorDescriptionHtml: constructorElement
+      ? markdown(getDescription(constructorElement))
+      : null,
     properties: properties.map((property) => ({
       name: property.name,
-      signature: markdownInline(formatTypeToString(property.getSignature.type)),
+      signature: markdownInline(
+        formatTypeToString(property.getSignature?.type ?? property.type),
+      ),
       descriptionHtml: markdown(getDescription(property)),
     })),
     methods: methods.map((method) => processFunction(method, importPath)),
+    staticMethods: staticMethods.map((method) =>
+      processFunction(method, importPath),
+    ),
     extends: apiElement.extendedTypes?.map((extended) => ({
       signature: markdownInline(formatTypeToString(extended)),
     })),
   };
 }
 
 function processFunction(apiElement, importPath) {
-  const signature = apiElement?.signatures?.[0];
+  const signature = apiElement.signatures?.[0];
 
   return {
     name: apiElement.name,

app/index.md

@@ -7,13 +7,13 @@ title: Docs
 
 ## Presentation
 
-<span class="lib-name">ogc-client</span> is a pure Javascript library made for interacting with geospatial web services relying on standard protocols, namely [OGC standards](https://www.ogc.org/docs/is).
+<span class="lib-name">ogc-client</span> is a Typescript library made for interacting with geospatial web services relying on standard protocols, namely [OGC standards](https://www.ogc.org/docs/is).
 
 Its purpose is to help you interact with them in a user-friendly and consistent way.
 
 Its main features include:
 
-- Support for many protoocols such as [WFS](https://www.ogc.org/standards/wfs), [WMS](https://www.ogc.org/standards/wms), [WMTS](https://www.ogc.org/standards/wmts), [WPS](https://www.ogc.org/standards/wps), [OGC API](https://ogcapi.ogc.org/), STAC API, TMS and NcWMS extension
+- Support for many protocols such as [WFS](https://www.ogc.org/standards/wfs), [WMS](https://www.ogc.org/standards/wms), [WMTS](https://www.ogc.org/standards/wmts), [WPS](https://www.ogc.org/standards/wps), [OGC API](https://ogcapi.ogc.org/), STAC API, TMS and NcWMS extension
 - Elaborate cache system to minimize network requests
 - Fast parsing of XML documents using [@rgrove/parse-xml](https://github.com/rgrove/parse-xml)
 - Detection of [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)-related issues

app/src/components/apidoc/ClassCard.vue

@@ -15,8 +15,11 @@
     <MarkdownBlock :html="apiElement.importHtml"></MarkdownBlock>
     <MarkdownBlock :html="apiElement.descriptionHtml" />
 
-    <h4>📦 Constructor</h4>
-    <CodeBlock :html="apiElement.constructorSignature"></CodeBlock>
+    <h4 v-if="apiElement.constructor">📦 Constructor</h4>
+    <CodeBlock
+      v-if="apiElement.constructor"
+      :html="apiElement.constructorSignature"
+    ></CodeBlock>
     <table v-if="apiElement.constructor?.parameters?.length > 0">
       <thead>
         <tr>
@@ -51,7 +54,7 @@
       <CodeBlock :html="extended.signature"></CodeBlock>
     </template>
 
-    <h4 v-if="apiElement.properties?.length > 0">💡 Accessors</h4>
+    <h4 v-if="apiElement.properties?.length > 0">💡 Properties</h4>
     <table v-if="apiElement.properties?.length > 0">
       <thead>
         <tr>
@@ -77,7 +80,13 @@
       </tbody>
     </table>
 
-    <h4 v-if="apiElement.methods?.length > 0">⚡️ Methods</h4>
+    <h4
+      v-if="
+        apiElement.methods?.length > 0 || apiElement.staticMethods?.length > 0
+      "
+    >
+      ⚡️ Methods
+    </h4>
     <template v-for="method in apiElement.methods" style="display: contents">
       <br />
       <h5>
@@ -111,7 +120,66 @@
       <table v-if="!!method.returns">
         <thead>
           <tr>
-            <th>Return type</th>
+            <th>Return&nbsp;type</th>
+            <th>Description</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <td><code v-html="method.returns"></code></td>
+            <td>
+              <MarkdownBlock
+                v-if="method.returnsDescriptionHtml"
+                class="mb-2 small"
+                :html="method.returnsDescriptionHtml"
+              />
+            </td>
+          </tr>
+        </tbody>
+      </table>
+      <MarkdownBlock
+        v-if="method.descriptionHtml"
+        :html="method.descriptionHtml"
+      />
+    </template>
+    <template
+      v-for="method in apiElement.staticMethods"
+      style="display: contents"
+    >
+      <br />
+      <h5>
+        <Badge type="tip" text="static" />&nbsp;
+        <code>{{ method.name }}()</code>
+      </h5>
+      <CodeBlock :html="method.signature"></CodeBlock>
+      <table v-if="method.parameters?.length > 0">
+        <thead>
+          <tr>
+            <th>Parameter</th>
+            <th>Type</th>
+            <th>Description</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr v-for="parameter in method.parameters">
+            <td>
+              <code>{{ parameter.name }}</code>
+            </td>
+            <td><code v-html="parameter.signature"></code></td>
+            <td>
+              <MarkdownBlock
+                v-if="parameter.descriptionHtml"
+                class="mb-2 small"
+                :html="parameter.descriptionHtml"
+              />
+            </td>
+          </tr>
+        </tbody>
+      </table>
+      <table v-if="!!method.returns">
+        <thead>
+          <tr>
+            <th>Return&nbsp;type</th>
             <th>Description</th>
           </tr>
         </thead>

app/src/components/apidoc/FunctionCard.vue

@@ -41,7 +41,7 @@
     <table v-if="!!apiElement.returns">
       <thead>
         <tr>
-          <th>Return type</th>
+          <th>Return&nbsp;type</th>
           <th>Description</th>
         </tr>
       </thead>

examples/ncwms.js

@@ -10,18 +10,13 @@
  * Run with: node examples/ncwms.js
  */
 
-import { getDimensionDefaultValue, NcwmsEndpoint } from '../dist/dist-node.js';
+import { NcwmsEndpoint } from '../dist/dist-node.js';
 
 const NCWMS_URL =
   'https://tds0.ifremer.fr/thredds/wms/LPO_GLOBANA_ISAS20_ARGO_MNTH_TIME_SERIE?service=WMS&request=GetCapabilities';
 const LAYER_NAME = 'TEMP';
 const SAMPLE_BBOX = [-60, 30, -30, 50];
 
-function getLayerDimensionValue(layer, dimensionName) {
-  const dimension = layer.dimensions?.find((dim) => dim.name === dimensionName);
-  return dimension ? getDimensionDefaultValue(dimension) : null;
-}
-
 async function main() {
   try {
     console.log('╔═══════════════════════════════════════════════════════╗');
@@ -36,8 +31,8 @@ async function main() {
       throw new Error(`Layer "${LAYER_NAME}" was not found.`);
     }
 
-    const time = getLayerDimensionValue(layer, 'time');
-    const elevation = getLayerDimensionValue(layer, 'elevation');
+    const time = layer.timeDimension?.defaultValue;
+    const elevation = layer.elevationDimension?.defaultValue;
 
     if (!time || !elevation) {
       throw new Error(