Skip to content

Commit 54af0f0

Browse files
juanrgmjuanrgm
committed
feat(web-manifest): add package
1 parent e06a6ec commit 54af0f0

File tree

7 files changed

+455
-0
lines changed

7 files changed

+455
-0
lines changed

‎catalog.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
"patches": {
99
"removeYamlAnchor": true
1010
}
11+
},
12+
{
13+
"name": "web-manifest",
14+
"url": "https://json.schemastore.org/web-manifest.json",
15+
"patches": {
16+
"additionalProperties": false
17+
}
1118
}
1219
]
1320
}

‎packages/web-manifest/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# @json-types/web-manifest
2+
3+
## Installation
4+
5+
```sh
6+
npm install --save @json-types/web-manifest
7+
```
8+
9+
## Usage
10+
11+
```ts
12+
import { WebManifest } from "@json-types/web-manifest";
13+
```
14+
15+
## Details
16+
17+
TypeScript types generated automatically every night and published when there are changes.
18+
19+
- Last change: 2023-10-21T23:35:38.511Z
20+
- Source URL: https://json.schemastore.org/web-manifest.json

‎packages/web-manifest/index.cjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {};

‎packages/web-manifest/index.d.ts‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
/* eslint-disable */
2+
/**
3+
* This file was automatically generated by json-schema-to-typescript.
4+
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5+
* and run json-schema-to-typescript to regenerate this file.
6+
*/
7+
8+
export interface WebManifest {
9+
/**
10+
* The background_color member describes the expected background color of the web application.
11+
*/
12+
background_color?: string;
13+
/**
14+
* The base direction of the manifest.
15+
*/
16+
dir?: "ltr" | "rtl" | "auto";
17+
/**
18+
* The item represents the developer's preferred display mode for the web application.
19+
*/
20+
display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
21+
/**
22+
* The icons member is an array of icon objects that can serve as iconic representations of the web application in various contexts.
23+
*/
24+
icons?: ManifestImageResource[];
25+
/**
26+
* The primary language for the values of the manifest.
27+
*/
28+
lang?: string;
29+
/**
30+
* The name of the web application.
31+
*/
32+
name?: string;
33+
/**
34+
* The orientation member is a string that serves as the default orientation for all top-level browsing contexts of the web application.
35+
*/
36+
orientation?:
37+
| "any"
38+
| "natural"
39+
| "landscape"
40+
| "portrait"
41+
| "portrait-primary"
42+
| "portrait-secondary"
43+
| "landscape-primary"
44+
| "landscape-secondary";
45+
/**
46+
* Boolean value that is used as a hint for the user agent to say that related applications should be preferred over the web application.
47+
*/
48+
prefer_related_applications?: boolean;
49+
/**
50+
* Array of application accessible to the underlying application platform that has a relationship with the web application.
51+
*/
52+
related_applications?: ExternalApplicationResource[];
53+
/**
54+
* A string that represents the navigation scope of this web application's application context.
55+
*/
56+
scope?: string;
57+
/**
58+
* A string that represents a short version of the name of the web application.
59+
*/
60+
short_name?: string;
61+
/**
62+
* Array of shortcut items that provide access to key tasks within a web application.
63+
*/
64+
shortcuts?: ShortcutItem[];
65+
/**
66+
* Represents the URL that the developer would prefer the user agent load when the user launches the web application.
67+
*/
68+
start_url?: string;
69+
/**
70+
* The theme_color member serves as the default theme color for an application context.
71+
*/
72+
theme_color?: string;
73+
/**
74+
* A string that represents the id of the web application.
75+
*/
76+
id?: string;
77+
}
78+
export interface ManifestImageResource {
79+
/**
80+
* The sizes member is a string consisting of an unordered set of unique space-separated tokens which are ASCII case-insensitive that represents the dimensions of an image for visual media.
81+
*/
82+
sizes?: string | "any";
83+
/**
84+
* The src member of an image is a URL from which a user agent can fetch the icon's data.
85+
*/
86+
src: string;
87+
/**
88+
* The type member of an image is a hint as to the media type of the image.
89+
*/
90+
type?: string;
91+
purpose?:
92+
| "monochrome"
93+
| "maskable"
94+
| "any"
95+
| "monochrome maskable"
96+
| "monochrome any"
97+
| "maskable monochrome"
98+
| "maskable any"
99+
| "any monochrome"
100+
| "any maskable"
101+
| "monochrome maskable any"
102+
| "monochrome any maskable"
103+
| "maskable monochrome any"
104+
| "maskable any monochrome"
105+
| "any monochrome maskable"
106+
| "any maskable monochrome";
107+
}
108+
export interface ExternalApplicationResource {
109+
/**
110+
* The platform it is associated to.
111+
*/
112+
platform: "chrome_web_store" | "play" | "itunes" | "windows";
113+
/**
114+
* The URL where the application can be found.
115+
*/
116+
url?: string;
117+
/**
118+
* Information additional to the URL or instead of the URL, depending on the platform.
119+
*/
120+
id?: string;
121+
/**
122+
* Information about the minimum version of an application related to this web app.
123+
*/
124+
min_version?: string;
125+
/**
126+
* An array of fingerprint objects used for verifying the application.
127+
*/
128+
fingerprints?: {
129+
type?: string;
130+
value?: string;
131+
}[];
132+
}
133+
/**
134+
* A shortcut item represents a link to a key task or page within a web app. A user agent can use these values to assemble a context menu to be displayed by the operating system when a user engages with the web app's icon.
135+
*/
136+
export interface ShortcutItem {
137+
/**
138+
* The name member of a shortcut item is a string that represents the name of the shortcut as it is usually displayed to the user in a context menu.
139+
*/
140+
name: string;
141+
/**
142+
* The short_name member of a shortcut item is a string that represents a short version of the name of the shortcut. It is intended to be used where there is insufficient space to display the full name of the shortcut.
143+
*/
144+
short_name?: string;
145+
/**
146+
* The description member of a shortcut item is a string that allows the developer to describe the purpose of the shortcut.
147+
*/
148+
description?: string;
149+
/**
150+
* The url member of a shortcut item is a URL within scope of a processed manifest that opens when the associated shortcut is activated.
151+
*/
152+
url: string;
153+
/**
154+
* The icons member of a shortcut item serves as iconic representations of the shortcut in various contexts.
155+
*/
156+
icons?: ManifestImageResource[];
157+
}

‎packages/web-manifest/index.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export {};

‎packages/web-manifest/package.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"name": "@json-types/web-manifest",
3+
"version": "0.1.0",
4+
"description": "TypeScript type for web-manifest",
5+
"keywords": [
6+
"typescript",
7+
"json-schema",
8+
"schema",
9+
"typing",
10+
"type",
11+
"web-manifest"
12+
],
13+
"x-json-types": {
14+
"lastChangeDate": "2023-10-21T23:35:38.511Z"
15+
},
16+
"homepage": "https://github.com/swordev/json-types/tree/main/packages/web-manifest",
17+
"bugs": {
18+
"url": "https://github.com/swordev/json-types/issues",
19+
"email": "juanrgm724@gmail.com"
20+
},
21+
"repository": {
22+
"type": "git",
23+
"url": "https://github.com/swordev/json-types"
24+
},
25+
"license": "MIT",
26+
"author": {
27+
"name": "Juanra GM",
28+
"email": "juanrgm724@gmail.com",
29+
"url": "https://github.com/juanrgm"
30+
},
31+
"main": "index.cjs",
32+
"module": "index.mjs",
33+
"files": [
34+
"index.cjs",
35+
"index.mjs",
36+
"index.d.ts",
37+
"schema.json",
38+
"README.md"
39+
]
40+
}

0 commit comments

Comments
 (0)