@builder.io/sdk 1.1.27-0 → 1.1.27-3

package/docs/interfaces/InsertMenuItem.md

@@ -0,0 +1,39 @@
+# Interface: InsertMenuItem
+
+## Table of contents
+
+### Properties
+
+- [icon](InsertMenuItem.md#icon)
+- [item](InsertMenuItem.md#item)
+- [name](InsertMenuItem.md#name)
+
+## Properties
+
+### icon
+
+• `Optional` **icon**: `string`
+
+#### Defined in
+
+[builder.class.ts:732](https://github.com/builderio/builder/blob/faf038e7/packages/core/src/builder.class.ts#L732)
+
+___
+
+### item
+
+• **item**: `DeepPartial`<`BuilderElement`\>
+
+#### Defined in
+
+[builder.class.ts:733](https://github.com/builderio/builder/blob/faf038e7/packages/core/src/builder.class.ts#L733)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[builder.class.ts:731](https://github.com/builderio/builder/blob/faf038e7/packages/core/src/builder.class.ts#L731)

package/docs/interfaces/ParamsMap.md

@@ -0,0 +1,5 @@
+# Interface: ParamsMap
+
+## Indexable
+
+▪ [key: `string`]: `any`

package/docs/interfaces/UserAttributes.md

@@ -0,0 +1,25 @@
+# Interface: UserAttributes
+
+Attributes that can be used for custom targeting. [https://www.builder.io/c/docs/guides/targeting-and-scheduling](https://www.builder.io/c/docs/guides/targeting-and-scheduling)
+
+## Indexable
+
+▪ [key: `string`]: `undefined` \| `string` \| `string`[] \| `boolean` \| `boolean`[] \| `number` \| `number`[] \| `Record`<`string`, `any`\>
+
+## Table of contents
+
+### Properties
+
+- [urlPath](UserAttributes.md#urlpath)
+
+## Properties
+
+### urlPath
+
+• `Optional` **urlPath**: `string`
+
+URL path of the current user.
+
+#### Defined in
+
+[builder.class.ts:202](https://github.com/builderio/builder/blob/faf038e7/packages/core/src/builder.class.ts#L202)

package/jest.config.ts

@@ -23,7 +23,7 @@ export default {
   // collectCoverageFrom: undefined,
 
   // The directory where Jest should output its coverage files
-  coverageDirectory: "coverage",
+  coverageDirectory: 'coverage',
 
   // An array of regexp pattern strings used to skip coverage collection
   // coveragePathIgnorePatterns: [
@@ -31,7 +31,7 @@ export default {
   // ],
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
+  coverageProvider: 'v8',
 
   // A list of reporter names that Jest uses when writing coverage reports
   // coverageReporters: [
@@ -137,7 +137,7 @@ export default {
   // snapshotSerializers: [],
 
   // The test environment that will be used for testing
-  testEnvironment: "jsdom",
+  testEnvironment: 'jsdom',
 
   // Options that will be passed to the testEnvironment
   // testEnvironmentOptions: {},
@@ -173,7 +173,7 @@ export default {
 
   // A map from regular expressions to paths to transformers
   transform: {
-    "\\.ts$": "esbuild-runner/jest"
+    '\\.ts$': 'esbuild-runner/jest',
   },
 
   // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/sdk",
-  "version": "1.1.27-0",
+  "version": "1.1.27-3",
   "unpkg": "./dist/index.browser.js",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -13,6 +13,9 @@
   "scripts": {
     "_unlink": "npm unlink *",
     "_install": "npm install",
+    "docs": "npm run docs:generate && npm run docs:cleanup",
+    "docs:generate": "typedoc",
+    "docs:cleanup": "node scripts/cleanup-generated-docs",
     "build": "npm run tsc && rollup -c",
     "watch": "rollup -cw",
     "start": "npm run watch",
@@ -41,6 +44,8 @@
     "@types/virtual-dom": "^2.0.27",
     "esbuild": "0.14.14",
     "esbuild-runner": "2.2.1",
+    "glob": "^7.2.3",
+    "glob-promise": "^4.2.2",
     "jest": "27.4.7",
     "rollup": "^0.58.2",
     "rollup-plugin-alias": "^1.4.0",
@@ -53,7 +58,9 @@
     "rollup-plugin-typescript": "^0.8.1",
     "rollup-plugin-typescript2": "^0.13.0",
     "rollup-plugin-uglify": "^3.0.0",
-    "typescript": "^3.8.3"
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-markdown": "^3.12.1",
+    "typescript": "^4.6.4"
   },
   "dependencies": {
     "hash-sum": "^2.0.0",

package/scripts/cleanup-generated-docs.js

@@ -0,0 +1,18 @@
+const glob = require('glob-promise');
+const { readFile, writeFile } = require('fs').promises;
+
+/**
+ * Typedoc generates markdown files with links to docs that we gitignore,
+ * so let's clean out the dead links that display as breadcrumbs at the top
+ */
+async function main() {
+  const files = await glob('docs/**/*.md');
+  for (const file of files) {
+    const content = await readFile(file, 'utf8');
+    // Detect the initial breadcrumb pattern and remove it
+    const newContent = content.replace(/^\[@builder.io\/sdk\].*\n+/g, '');
+    await writeFile(file, newContent);
+  }
+}
+
+main();

package/typedoc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  entryPoints: ['./src/builder.class.ts'],
+  out: 'docs',
+  exclude: ['**/*.test.tsx?'],
+};

package/BUILD

@@ -1,19 +0,0 @@
-load("@npm//@bazel/typescript:index.bzl", "ts_project")
-
-package(default_visibility = ["//visibility:public"])
-
-ts_project(
-    name = "core",
-    srcs = glob(
-        [
-            "**/*.ts",
-        ],
-    ),
-    declaration = True,
-    source_map = True,
-    tsconfig = "//:tsconfig.json",
-    deps = [
-        "@npm_core//@types/node",
-        "@npm_core//tslib",
-    ],
-)