@cparra/apexdocs 3.0.0-beta.1 → 3.0.0

package/dist/defaults-BcE8DTat.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const defaults = {
+  targetGenerator: "markdown",
+  targetDir: "./docs/",
+  scope: ["global"],
+  defaultGroupName: "Miscellaneous",
+  includeMetadata: false,
+  sortAlphabetically: false,
+  linkingStrategy: "relative"
+};
+
+exports.defaults = defaults;

package/dist/defaults-D07y_bq4.js

@@ -0,0 +1,40 @@
+'use strict';
+
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+const commonDefaults = {
+  targetDir: "./docs/"
+};
+const markdownDefaults = __spreadProps(__spreadValues({}, commonDefaults), {
+  scope: ["global"],
+  defaultGroupName: "Miscellaneous",
+  includeMetadata: false,
+  sortAlphabetically: false,
+  linkingStrategy: "relative",
+  referenceGuideTitle: "Apex Reference Guide"
+});
+const openApiDefaults = __spreadProps(__spreadValues({}, commonDefaults), {
+  fileName: "openapi",
+  title: "Apex REST API",
+  apiVersion: "1.0.0"
+});
+
+exports.markdownDefaults = markdownDefaults;
+exports.openApiDefaults = openApiDefaults;

package/dist/defaults-gPzwP66p.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const defaults = {
+  targetGenerator: "markdown",
+  targetDir: "./docs/",
+  scope: ["global"],
+  defaultGroupName: "Miscellaneous",
+  includeMetadata: false,
+  sortAlphabetically: false,
+  linkingStrategy: "relative",
+  referenceGuideTitle: "Apex Reference Guide"
+};
+
+exports.defaults = defaults;

package/dist/index.d.ts

@@ -1,15 +1,3 @@
-import { SetOptional } from 'type-fest';
-
-/**
- * The configurable hooks that can be used to modify the output of the generator.
- */
-type ConfigurableHooks = {
-  transformReferenceGuide: TransformReferenceGuide;
-  transformDocs: TransformDocs;
-  transformDocPage: TransformDocPage;
-  transformReference: TransformReference;
-};
-
 type LinkingStrategy =
   // Links will be generated using relative paths.
   | 'relative'
@@ -22,17 +10,31 @@ type LinkingStrategy =
   | 'none';
 
 type UserDefinedMarkdownConfig = {
-  targetGenerator: 'markdown';
   sourceDir: string;
+  targetGenerator: 'markdown';
   targetDir: string;
   scope: string[];
-  defaultGroupName: string;
   namespace?: string;
-  sortMembersAlphabetically: boolean;
+  defaultGroupName: string;
+  sortAlphabetically: boolean;
   includeMetadata: boolean;
   linkingStrategy: LinkingStrategy;
+  excludeTags: string[];
+  referenceGuideTitle: string;
 } & Partial<ConfigurableHooks>;
 
+type UserDefinedOpenApiConfig = {
+  targetGenerator: 'openapi';
+  sourceDir: string;
+  targetDir: string;
+  fileName: string;
+  namespace?: string;
+  title: string;
+  apiVersion: string;
+};
+
+type UserDefinedConfig = UserDefinedMarkdownConfig | UserDefinedOpenApiConfig;
+
 type SourceFileMetadata = {
   filePath: string;
   name: string;
@@ -76,7 +78,17 @@ type Skip = {
   readonly _tag: 'Skip';
 };
 
-// Configurable Hooks
+// CONFIGURABLE HOOKS
+
+/**
+ * The configurable hooks that can be used to modify the output of the generator.
+ */
+type ConfigurableHooks = {
+  transformReferenceGuide: TransformReferenceGuide;
+  transformDocs: TransformDocs;
+  transformDocPage: TransformDocPage;
+  transformReference: TransformReference;
+};
 
 type ConfigurableDocPageReference = Omit<DocPageReference, 'source'>;
 
@@ -110,8 +122,26 @@ type TransformDocPage = (
   doc: DocPageData,
 ) => Partial<ConfigurableDocPageData> | Promise<Partial<ConfigurableDocPageData>>;
 
-type ConfigurableMarkdownConfig = Omit<SetOptional<UserDefinedMarkdownConfig, 'targetDir' | 'scope' | 'defaultGroupName' | 'includeMetadata' | 'sortMembersAlphabetically' | 'linkingStrategy'>, 'targetGenerator'>;
-declare function defineMarkdownConfig(config: ConfigurableMarkdownConfig): UserDefinedMarkdownConfig;
+type ConfigurableMarkdownConfig = Omit<Partial<UserDefinedMarkdownConfig>, 'targetGenerator'>;
+/**
+ * Helper function to define a configuration to generate Markdown documentation.
+ * @param config The configuration to use.
+ */
+declare function defineMarkdownConfig(config: ConfigurableMarkdownConfig): Partial<UserDefinedMarkdownConfig>;
+type ConfigurableOpenApiConfig = Omit<Partial<UserDefinedOpenApiConfig>, 'targetGenerator'>;
+/**
+ * Helper function to define a configuration to generate OpenAPI documentation.
+ * @param config The configuration to use.
+ */
+declare function defineOpenApiConfig(config: ConfigurableOpenApiConfig): Partial<UserDefinedOpenApiConfig>;
+/**
+ * Represents a file to be skipped.
+ */
 declare function skip(): Skip;
+type CallableConfig = Partial<UserDefinedConfig> & {
+    sourceDir: string;
+    targetGenerator: 'markdown' | 'openapi';
+};
+declare function process(config: CallableConfig): Promise<void>;
 
-export { type ConfigurableHooks, type DocPageData, type DocPageReference, type ReferenceGuidePageData, defineMarkdownConfig, skip };
+export { type ConfigurableDocPageData, type ConfigurableDocPageReference, type ConfigurableHooks, type ConfigurableMarkdownConfig, type ConfigurableOpenApiConfig, type DocPageData, type DocPageReference, type ReferenceGuidePageData, type Skip, type TransformDocPage, type TransformDocs, type TransformReference, type TransformReferenceGuide, defineMarkdownConfig, defineOpenApiConfig, process, skip };

package/dist/index.js

@@ -1,6 +1,40 @@
 'use strict';
 
-var defaults = require('./defaults-DGKfeZq-.js');
+var logger = require('./logger-Ce4QqPFR.js');
+var E = require('fp-ts/Either');
+require('fp-ts/function');
+require('fp-ts/TaskEither');
+require('js-yaml');
+require('path');
+require('fp-ts/Task');
+require('fp-ts/lib/Array');
+require('@cparra/apex-reflection');
+require('fp-ts/Option');
+require('fast-xml-parser');
+require('handlebars');
+require('fp-ts/boolean');
+require('fs');
+require('fp-ts/lib/TaskEither');
+require('chalk');
+
+function _interopNamespaceDefault(e) {
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
 
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
@@ -21,16 +55,70 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 function defineMarkdownConfig(config) {
-  return __spreadProps(__spreadValues(__spreadValues({}, defaults.defaults), config), {
+  return __spreadProps(__spreadValues(__spreadValues({}, logger.markdownDefaults), config), {
     targetGenerator: "markdown"
   });
 }
+function defineOpenApiConfig(config) {
+  return __spreadProps(__spreadValues(__spreadValues({}, logger.openApiDefaults), config), {
+    targetGenerator: "openapi"
+  });
+}
 function skip() {
   return {
     _tag: "Skip"
   };
 }
+function process(config) {
+  return __async(this, null, function* () {
+    const logger$1 = new logger.NoLogger();
+    const configWithDefaults = __spreadValues(__spreadValues({}, getDefault(config)), config);
+    if (!configWithDefaults.sourceDir) {
+      throw new Error("sourceDir is required");
+    }
+    const result = yield logger.Apexdocs.generate(configWithDefaults, logger$1);
+    E__namespace.match(
+      (errors) => {
+        throw errors;
+      },
+      () => {
+      }
+    )(result);
+  });
+}
+function getDefault(config) {
+  switch (config.targetGenerator) {
+    case "markdown":
+      return logger.markdownDefaults;
+    case "openapi":
+      return logger.openApiDefaults;
+    default:
+      throw new Error("Unknown target generator");
+  }
+}
 
 exports.defineMarkdownConfig = defineMarkdownConfig;
+exports.defineOpenApiConfig = defineOpenApiConfig;
+exports.process = process;
 exports.skip = skip;