@hyperbook/types 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Mike Barkmin
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,9 @@
1
+ # @hyperbook/types
2
+
3
+ ## Installation
4
+
5
+ ```sh
6
+ yarn add @hyperbook/types
7
+ # or
8
+ npm i @hyperbook/types
9
+ ```
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __copyProps = (to, from, except, desc) => {
7
+ if (from && typeof from === "object" || typeof from === "function") {
8
+ for (let key of __getOwnPropNames(from))
9
+ if (!__hasOwnProp.call(to, key) && key !== except)
10
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
+ }
12
+ return to;
13
+ };
14
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
15
+
16
+ // src/index.ts
17
+ var src_exports = {};
18
+ module.exports = __toCommonJS(src_exports);
19
+ //# sourceMappingURL=index.cjs.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../src/index.ts"],
4
+ "sourcesContent": ["export type HyperbookJson = {\n name: string;\n description?: string;\n logo?: string;\n author?: {\n name?: string;\n url?: string;\n };\n font?: string;\n fonts?: {\n heading?: string;\n body?: string;\n code?: string;\n };\n template?: string;\n colors?: {\n /**\n * @format color-hex\n */\n brand?: string;\n /**\n * @format color-hex\n */\n brandDark?: string;\n /**\n * @format color-hex\n */\n brandText?: string;\n inverted?: boolean;\n };\n basePath?: string;\n license?: string;\n language?: \"de\" | \"en\" | \"fr\" | \"es\";\n repo?: string;\n};\n"],
5
+ "mappings": ";;;;;;;;;;;;;;;;AAAA;AAAA;",
6
+ "names": []
7
+ }
@@ -0,0 +1,35 @@
1
+ export declare type HyperbookJson = {
2
+ name: string;
3
+ description?: string;
4
+ logo?: string;
5
+ author?: {
6
+ name?: string;
7
+ url?: string;
8
+ };
9
+ font?: string;
10
+ fonts?: {
11
+ heading?: string;
12
+ body?: string;
13
+ code?: string;
14
+ };
15
+ template?: string;
16
+ colors?: {
17
+ /**
18
+ * @format color-hex
19
+ */
20
+ brand?: string;
21
+ /**
22
+ * @format color-hex
23
+ */
24
+ brandDark?: string;
25
+ /**
26
+ * @format color-hex
27
+ */
28
+ brandText?: string;
29
+ inverted?: boolean;
30
+ };
31
+ basePath?: string;
32
+ license?: string;
33
+ language?: "de" | "en" | "fr" | "es";
34
+ repo?: string;
35
+ };
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=index.esm.mjs.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": [],
4
+ "sourcesContent": [],
5
+ "mappings": "",
6
+ "names": []
7
+ }
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@hyperbook/types",
3
+ "version": "0.0.1",
4
+ "author": "Mike Barkmin",
5
+ "homepage": "https://github.com/openpatch/hyperbook#readme",
6
+ "license": "MIT",
7
+ "main": "dist/index.cjs.js",
8
+ "module": "dist/index.esm.mjs",
9
+ "types": "dist/index.d.ts",
10
+ "typings": "dist/index.d.ts",
11
+ "sideEffects": false,
12
+ "exports": {
13
+ ".": {
14
+ "require": "./dist/index.cjs.js",
15
+ "default": "./dist/index.esm.mjs"
16
+ }
17
+ },
18
+ "files": [
19
+ "dist"
20
+ ],
21
+ "publishConfig": {
22
+ "access": "public"
23
+ },
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "git+https://github.com/openpatch/hyperbook.git",
27
+ "directory": "packages/types"
28
+ },
29
+ "bugs": {
30
+ "url": "https://github.com/openpatch/hyperbook/issues"
31
+ },
32
+ "dependencies": {},
33
+ "scripts": {
34
+ "prebuild": "rimraf dist",
35
+ "version": "pnpm build",
36
+ "lint": "tsc --noEmit",
37
+ "build": "pnpm build:pkg && pnpm build:types",
38
+ "build:pkg": "node ../../scripts/build.mjs",
39
+ "build:types": "tsc --project tsconfig.build.json --declaration --emitDeclarationOnly"
40
+ }
41
+ }