ol-stac 0.0.0

package/config/jsdoc/api/template/tmpl/method.tmpl

@@ -0,0 +1,132 @@
+<?js
+var data = obj;
+var self = this;
+var version = self.find({kind: 'package' })[0].version;
+if (/-dev$/.test(version)) {
+    version = 'main';
+} else {
+    version = 'v' + version;
+}
+?>
+<dt class="<?js= (data.stability && data.stability !== 'stable') ? 'unstable' : '' ?>">
+    <?js if (data.stability || kind !== 'class') { ?>
+    <div class="nameContainer<?js if (data.inherited) { ?> inherited<?js } ?>">
+        <div class="anchor" id="<?js= id ?>">
+        </div>
+        <h4 class="name">
+            <?js= data.attribs + (kind === 'class' ? 'new ' : '') + this.getShortName(longname) + (kind !== 'event' ? data.signature : '') ?>
+            <?js if (data.inherited || data.inherits) { ?>
+                <span class="inherited"><?js= this.linkto(data.inherits, 'inherited') ?></span>
+            <?js } ?>
+            <?js= this.partial('stability.tmpl', data) ?>
+        </h4>
+        <?js if (data.meta) {?>
+        <div class="tag-source">
+            <a href="https://github.com/m-mohr/ol-stac/blob/<?js= version ?>/src/ol/<?js= meta.filename ?>"><?js= meta.filename ?></a>,
+            <a href="https://github.com/m-mohr/ol-stac/blob/<?js= version ?>/src/ol/<?js= meta.filename ?>#L<?js= meta.lineno ?>">line <?js= meta.lineno ?></a>
+        </div>
+        <?js } ?>
+    </div>
+    <?js } ?>
+    <?js if (data.summary) { ?>
+    <p class="summary"><?js= summary ?></p>
+    <?js } ?>
+</dt>
+<dd class="<?js= (data.stability && data.stability !== 'stable') ? 'unstable' : '' ?>">
+
+<?js if (data.parent && data.parent.kind == 'module') { ?>
+    <?js const importName = data.isDefaultExport ? data.name : `{${data.name}}`; ?>
+    <pre class="prettyprint source"><code>import <?js= importName ?> from '<?js= data.parent.name ?>';</code></pre>
+<?js } ?>
+
+    <?js if (data.description) { ?>
+    <div class="description">
+        <?js= data.description ?>
+    </div>
+    <?js } ?>
+
+    <?js if (kind === 'event' && data.type && data.type.names) {?>
+        <h5>Type:</h5>
+        <ul>
+            <li>
+                <?js= self.partial('type.tmpl', data.type.names) ?>
+            </li>
+        </ul>
+    <?js } ?>
+
+    <?js if (data['this']) { ?>
+        <h5>This:</h5>
+        <ul><li><?js= this.linkto(data['this']) ?></li></ul>
+    <?js } ?>
+
+    <?js if (data.stability || kind !== 'class') { ?>
+    <?js if (data.params && params.length) { ?>
+        <?js= this.partial('params.tmpl', params) ?>
+    <?js } ?>
+    <?js } ?>
+
+    <?js= this.partial('details.tmpl', data) ?>
+
+    <?js if (data.fires && fires.length) { ?>
+    <h5>Fires:</h5>
+    <ul><?js fires.forEach(function(f) {
+            var parts = f.split(/#?event:/);
+            var type = parts.pop();
+            var eventClass = self.find({longname: parts[0]})[0];
+            parts = type.split(' ');
+            type = parts.shift();
+            var description = parts.length ? parts.join(' ') : '';
+            var eventDoclet = self.find({longname: f})[0];
+            if (eventDoclet && !description && eventDoclet.description) {
+              description = eventDoclet.description.replace(/<[^>]*>/g, '');
+            }
+        ?>
+        <li class="<?js= (eventDoclet || data).stability !== 'stable' ? 'unstable' : '' ?>">
+            <code><?js= eventClass ? self.linkto(f, type) : type ?></code>
+            <?js if (eventClass) { ?>
+              (<?js= self.linkto(eventClass.longname) ?>)
+            <?js } ?>
+            <?js= self.partial('stability.tmpl', eventDoclet || (data.stability ? data : {})) ?>
+            <?js if (description) { ?> -
+            <?js= description ?>
+            <?js } ?>
+        </li>
+    <?js }); ?></ul>
+    <?js } ?>
+
+    <?js if (data.listens && listens.length) { ?>
+    <h5>Listens to Events:</h5>
+    <ul><?js listens.forEach(function(f) { ?>
+        <li><?js= self.linkto(f) ?></li>
+    <?js }); ?></ul>
+    <?js } ?>
+
+    <?js if (data.listeners && listeners.length) { ?>
+    <h5>Listeners of This Event:</h5>
+    <ul><?js listeners.forEach(function(f) { ?>
+        <li><?js= self.linkto(f) ?></li>
+    <?js }); ?></ul>
+    <?js } ?>
+
+    <?js if (data.exceptions && exceptions.length) { ?>
+    <h5>Throws:</h5>
+    <?js if (exceptions.length > 1) { ?><ul><?js
+        exceptions.forEach(function(r) { ?>
+            <li><?js= self.partial('exceptions.tmpl', r) ?></li>
+        <?js });
+    ?></ul><?js } else {
+        exceptions.forEach(function(r) { ?>
+            <?js= self.partial('exceptions.tmpl', r) ?>
+        <?js });
+    } } ?>
+
+    <?js if (data.returns && returns.length) { ?>
+    <?js if (returns.length > 1) { ?><h5>Returns:</h5><?js } ?>
+    <?js= self.partial('returns.tmpl', data.returns) ?>
+    <?js } ?>
+
+    <?js if (data.examples && examples.length) { ?>
+        <h5>Example<?js= examples.length > 1? 's':'' ?></h5>
+        <?js= this.partial('examples.tmpl', examples) ?>
+    <?js } ?>
+</dd>

package/config/jsdoc/api/template/tmpl/navigation.tmpl

@@ -0,0 +1,59 @@
+<?js
+var self = this;
+
+function toShortName(name) {
+    return name.startsWith('module:') ? name.split('/').pop() : name;
+}
+
+function getItemCssClass(type) {
+    if (type === 'module') {
+        return 'fa-plus';
+    } else if (type === 'class') {
+        return 'fa-chevron-right';
+    }
+    return '';
+}
+
+const printListItem = (member) => {
+    const shortName = toShortName(member.name); ?>
+            <li data-name="<?js= shortName.toLowerCase() ?>"><?js= self.linkto(member.longname, shortName) ?><?js
+};
+const printListItemWithStability = (member) => {
+    const shortName = toShortName(member.name);
+    const cls = member.stability && member.stability !== 'stable' ? ' class="unstable"' : ''; ?>
+            <li data-name="<?js= shortName.toLowerCase() ?>"<?js= cls ?>><?js= self.linkto(member.longname, shortName) ?><?js
+};
+const printFiresListItem = (eventName) => {
+    const ancestor = self.find({longname: eventName})[0] ||
+        {longname: eventName, name: eventName.split(/#?event:/)[1]};
+    const eventEnum = ancestor.longname.split(/#?event:/)[0];
+    if (self.find({longname: eventEnum})[0]) {
+        printListItemWithStability(ancestor);
+    } else {
+        const cls = ancestor.stability && ancestor.stability !== 'stable' ? ' class="unstable"' : '';
+        const shortName = toShortName(ancestor.name); ?>
+            <li data-name="<?js= shortName.toLowerCase() ?>"<?js= cls ?>><?js= shortName ?><?js
+    }
+};
+
+function listContent(item, title, listItemPrinter) {
+    const type = title.toLowerCase();
+    if (item[type] && item[type].length) { ?>
+    <div class="member-list" data-type="<?js= type ?>">
+        <span class="subtitle"><?js= title ?></span>
+        <ul><?js
+        item[type].forEach((v) => listItemPrinter(v)); ?>
+        </ul>
+    </div><?js
+    }
+} ?>
+<li class="item item-<?js= item.type ?><?js= obj.classes || '' ?>" data-longname="<?js= item.longname ?>" data-name="<?js= item.prettyname.toLowerCase() ?>">
+    <span class="title toggle">
+        <span class="fa <?js= getItemCssClass(item.type) ?> me-2 mt-1"></span>
+        <span><?js= self.linkto(item.longname, item.prettyname.replace(/[.~\/]/g, '\u200b$&')) ?></span>
+    </span><?js
+listContent(item, 'Members', printListItem);
+listContent(item, 'Typedefs', printListItemWithStability);
+listContent(item, 'Methods', printListItemWithStability);
+listContent(item, 'Fires', printFiresListItem);
+?>

package/config/jsdoc/api/template/tmpl/observables.tmpl

@@ -0,0 +1,39 @@
+<?js
+    var props = obj;
+?>
+
+<table class="props">
+    <thead>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Settable</th>
+    <th><a href="module-ol_Object.ObjectEvent.html">ObjectEvent</a> type</th>
+    <th class="last">Description</th>
+  </tr>
+  </thead>
+
+  <tbody>
+  <?js
+      var self = this;
+      var propsByName = {};
+      props.forEach(function(prop) {
+        if (!prop || propsByName[prop.name]) { return; }
+        propsByName[prop.name] = prop;
+        var setter = prop.readonly ? 'no' : 'yes';
+  ?>
+
+    <tr class="<?js= (prop.stability && prop.stability !== 'stable') ? 'unstable' : '' ?>">
+      <td class="name"><code><?js= prop.name ?></code></td>
+      <td class="type">
+      <?js if (prop.type && prop.type.names) {?>
+      <?js= self.partial('type.tmpl', prop.type.names) ?>
+      <?js } ?>
+      </td>
+      <td class="setter"><?js= setter ?></td>
+      <td class="event"><code>change:<?js= prop.name.toLowerCase() ?></code></td>
+      <td class="description last"><?js= prop.description ?></td>
+    </tr>
+    <?js }); ?>
+  </tbody>
+</table>

package/config/jsdoc/api/template/tmpl/params.tmpl

@@ -0,0 +1,109 @@
+<?js
+    var params = obj;
+
+    /* sort subparams under their parent params (like opts.classname) */
+    var parentParam = null;
+    params.forEach(function(param, i) {
+        if (!param) { return; }
+        if (parentParam && param.name && param.name.startsWith(parentParam.name + '.')) {
+            param.name = param.name.substr(parentParam.name.length+1);
+            parentParam.subparams = parentParam.subparams || [];
+            parentParam.subparams.push(param);
+            params[i] = null;
+        }
+        else {
+            parentParam = param;
+        }
+    });
+
+    /* determine if we need extra "attributes" column */
+    params.hasAttributes = false;
+    params.hasName = false;
+
+    var colspan = 2;
+    params.forEach(function(param) {
+        if (!param) { return; }
+        if (param.type && param.type.names && param.type.names.includes('undefined')) {
+            param.optional = true;
+        }
+        if (param.name.startsWith('var_')) {
+            params.hasAttributes = true;
+            param.variable = true;
+        }
+
+        if (param.optional || param.nullable) {
+            params.hasAttributes = true;
+        }
+
+        if (param.name) {
+            params.hasName = true;
+        }
+
+    });
+?>
+
+<table class="params">
+    <thead>
+	<tr>
+		<?js if (params.hasName) {?>
+		<th>Name</th>
+		<?js } ?>
+
+		<th>Type</th>
+
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+
+	<tbody>
+	<?js
+        var self = this;
+
+        if (params[0].name === 'options' && params[0].subparams) {
+            var onlyOptions = true;
+            for (var i = 1; i < params.length; ++i) {
+                if (params[i]) {
+                    onlyOptions = false;
+                    break;
+                }
+            }
+            if (onlyOptions) {
+                var hasName = params.hasName;
+                params = params[0].subparams;
+                params.hasName = hasName;
+            }
+        }
+
+	    params.forEach(function(param) {
+	        if (!param) { return; }
+	?>
+
+        <tr class="<?js= (param.stability && param.stability !== 'stable') ? 'unstable' : '' ?>">
+            <?js if (params.hasName) {?>
+                <td class="name"><code><?js= param.name ?></code></td>
+            <?js } ?>
+
+            <?js if (!param.subparams) {?>
+            <td class="type">
+            <?js if (param.type && param.type.names) {?>
+                <?js= self.partial('type.tmpl', param.type.names) + (param.optional && typeof param.defaultvalue === 'undefined' && !param.type.names.includes('undefined') ? ' | undefined' : '') ?>
+                <?js if (typeof param.defaultvalue !== 'undefined') { ?>
+                    (defaults to <?js= self.htmlsafe(param.defaultvalue) ?>)
+                <?js } ?>
+            <?js } ?>
+            </td>
+
+            <?js } ?>
+
+            <td<?js= (param.subparams ? ' colspan=' + colspan : ' ') ?> class="description last">
+                <?js if (param.stability) { ?>
+                    <?js= self.partial('stability.tmpl', param) ?>
+                <?js } ?>
+                <?js= param.description ?><?js if (param.subparams) { ?>
+                <?js= self.partial('params.tmpl', param.subparams) ?>
+            <?js } ?></td>
+        </tr>
+
+	<?js }); ?>
+	</tbody>
+</table>

package/config/jsdoc/api/template/tmpl/properties.tmpl

@@ -0,0 +1,85 @@
+<?js
+    var props = obj;
+
+    /* sort subprops under their parent props (like opts.classname) */
+    var parentProp = null;
+    props.forEach(function(prop, i) {
+        if (!prop) { return; }
+        if (parentProp && prop.name && prop.name.startsWith(parentProp.name + '.')) {
+            prop.name = prop.name.substr(parentProp.name.length+1);
+            parentProp.subprops = parentProp.subprops || [];
+            parentProp.subprops.push(prop);
+            props[i] = null;
+        }
+        else {
+            parentProp = prop;
+        }
+    });
+
+    /* determine if we need extra columns, "attributes" and "default" */
+    props.hasAttributes = false;
+    props.hasDefault = false;
+    props.hasName = false;
+
+    props.forEach(function(prop) {
+        if (!prop) { return; }
+
+        if (prop.optional || prop.nullable) {
+            props.hasAttributes = true;
+        }
+
+        if (prop.name) {
+            props.hasName = true;
+        }
+
+        if (typeof prop.defaultvalue !== 'undefined') {
+            props.hasDefault = true;
+        }
+    });
+?>
+
+<table class="props">
+    <thead>
+	<tr>
+		<?js if (props.hasName) {?>
+		<th>Name</th>
+		<?js } ?>
+
+		<th>Type</th>
+
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+
+	<tbody>
+	<?js
+        var self = this;
+	    props.forEach(function(prop) {
+	        if (!prop) { return; }
+	?>
+
+        <tr>
+            <?js if (props.hasName) {?>
+                <td class="name"><code><?js= prop.name ?></code></td>
+            <?js } ?>
+
+            <td class="type">
+            <?js if (prop.type && prop.type.names) {?>
+                <?js= self.partial('type.tmpl', prop.type.names) + (prop.optional && typeof prop.defaultvalue === 'undefined' && !prop.type.names.includes('undefined') ? ' | undefined' : '') ?>
+                <?js if (typeof prop.defaultvalue !== 'undefined') { ?>
+                    <br>(defaults to <?js= self.htmlsafe(prop.defaultvalue) ?>)
+                <?js } ?>
+            <?js } ?>
+            </td>
+
+            <td class="description last">
+                <?js= prop.description ?>
+                <?js if (prop.subprops) { ?>
+                    <h6>Properties</h6><?js= self.partial('properties.tmpl', prop.subprops) ?>
+                <?js } ?>
+            </td>
+        </tr>
+
+	<?js }); ?>
+	</tbody>
+</table>

package/config/jsdoc/api/template/tmpl/returns.tmpl

@@ -0,0 +1,72 @@
+<?js
+var returns = obj;
+var parentReturn = null;
+
+returns.forEach(function (ret, i) {
+    if (ret && (ret.description || ret.name)) {
+        ret.description = ret.description.toString().replace(/<\/?p>/g, '');
+
+        var isNamed = ret.name ? true : false;
+        var name = ret.name || ret.description;
+        var startSpacePos = name.indexOf(" ");
+
+        if (parentReturn !== null && name.startsWith(parentReturn.name + '.')) {
+            ret.name = isNamed ? name.substr(parentReturn.name.length + 1) : name.substr(parentReturn.name.length + 1, startSpacePos - (parentReturn.name.length + 1));
+
+            parentReturn.subReturns = parentReturn.subReturns || [];
+            parentReturn.subReturns.push(ret);
+            returns[i] = null;
+        } else {
+            if (!isNamed) {
+                ret.name = ret.description.substr(0, startSpacePos !== -1 ? startSpacePos : ret.description.length);
+            }
+
+            parentReturn = ret;
+        }
+    }
+});
+?>
+
+<?js
+if (returns.length > 1) {
+?>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    <?js
+        var self = this;
+        returns.forEach(function(ret) {
+            if (!ret) {
+                return false;
+            }
+    ?>
+        <tr>
+            <td class="name"><code><?js= ret.name ?></code></td>
+            <td class="type">
+            <?js
+                if (ret.type && ret.type.names) {
+                    ret.type.names.forEach(function(name, i) { ?>
+                        <?js= self.linkto(name) ?>
+                        <?js if (i < ret.type.names.length-1) { ?> | <?js } ?>
+                    <?js });
+                }
+            ?>
+            </td>
+            <td class="description last"><?js= ret.description ?><?js if (ret.subReturns) { ?>
+                <?js= self.partial('returns.tmpl', ret.subReturns) ?>
+            <?js } ?></td>
+        </tr>
+    <?js }); ?>
+    </tbody>
+</table>
+<?js } else if (returns[0].description) { ?>
+<h5>Returns:</h5>
+<?js= returns[0].description ?>
+<br />
+<?js } ?>

package/config/jsdoc/api/template/tmpl/source.tmpl

@@ -0,0 +1,8 @@
+<?js
+    var data = obj;
+?>
+    <section>
+        <article>
+            <pre class="prettyprint source"><code><?js= data.code ?></code></pre>
+        </article>
+    </section>

package/config/jsdoc/api/template/tmpl/stability.tmpl

@@ -0,0 +1,7 @@
+<?js
+var data = obj;
+var self = this;
+
+if (data.stability && data.stability != 'stable') { ?>
+<span class="stability <?js= data.stability ?>"><?js= data.stability ?></span>
+<?js } ?>

package/config/jsdoc/api/template/tmpl/tutorial.tmpl

@@ -0,0 +1,19 @@
+<section>
+
+<header>
+    <?js if (children.length > 0) { ?>
+    <ul><?js
+        var self = this;
+        children.forEach(function(t) { ?>
+        <li><?js= self.tutoriallink(t.name) ?></li>
+    <?js }); ?></ul>
+    <?js } ?>
+
+    <h2><?js= header ?></h2>
+</header>
+
+<article>
+    <?js= content ?>
+</article>
+
+</section>

package/config/jsdoc/api/template/tmpl/type.tmpl

@@ -0,0 +1,7 @@
+<?js
+	var data = obj;
+    var self = this;
+    data.forEach(function(name, i) { ?>
+<span class="param-type"><?js= self.linkto(name) ?></span>
+<?js if (i < data.length-1) { ?>|<?js } ?>
+<?js }); ?>

package/config/jsdoc/info/conf.json

@@ -0,0 +1,22 @@
+{
+  "opts": {
+    "recurse": true,
+    "template": "config/jsdoc/info"
+  },
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "includePattern": "\\.js$"
+  },
+  "plugins": [
+    "jsdoc-plugin-intersection",
+    "jsdoc-plugin-typescript",
+    "config/jsdoc/plugins/define-plugin.cjs",
+    "config/jsdoc/plugins/virtual-plugin.cjs",
+    "config/jsdoc/plugins/default-export.cjs"
+  ],
+  "typescript": {
+    "moduleRoot": "src"
+  }
+}