@fluidframework/azure-local-service 1.2.0-106934 → 1.2.0

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/.eslintrc.js CHANGED
@@ -4,41 +4,9 @@
4
4
  */
5
5
 
6
6
  module.exports = {
7
- extends: [require.resolve("@fluidframework/eslint-config-fluid/strict")],
8
- plugins: ["eslint-plugin-jsdoc"],
9
- parserOptions: {
10
- project: ["./tsconfig.json"],
11
- },
12
- rules: {
13
- // Require jsdoc/tsdoc comments on public/exported API items.
14
- "jsdoc/require-jsdoc": [
15
- "error",
16
- {
17
- // Indicates that only module exports should be flagged for lacking jsdoc comments
18
- publicOnly: true,
19
- enableFixer: false, // Prevents eslint from adding empty comment blocks when run with `--fix`
20
- require: {
21
- ClassDeclaration: true,
22
- FunctionDeclaration: true,
23
-
24
- // Will report for *any* methods on exported classes, regardless of whether or not they are public
25
- MethodDefinition: false,
26
- },
27
- contexts: ["TSEnumDeclaration", "TSInterfaceDeclaration", "TSTypeAliasDeclaration"],
28
- },
29
- ],
30
-
31
- // Ensure jsdoc/tsdoc comments contain a main description component
32
- // (disallows empty comments / only tags).
33
- "jsdoc/require-description": ["error", { checkConstructors: false }],
34
- },
35
- overrides: [
36
- {
37
- files: ["packageVersion.ts"],
38
- rules: {
39
- "jsdoc/require-jsdoc": "off",
40
- "jsdoc/require-description": "off",
41
- },
42
- },
43
- ],
7
+ extends: [require.resolve("@fluidframework/eslint-config-fluid/strict"), "prettier"],
8
+ plugins: ["eslint-plugin-jsdoc"],
9
+ parserOptions: {
10
+ project: ["./tsconfig.json"],
11
+ },
44
12
  };
@@ -1,34 +1,29 @@
1
1
  {
2
- // Use IntelliSense to learn about possible attributes.
3
- // Hover to view descriptions of existing attributes.
4
- // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5
- "version": "0.2.0",
6
- "configurations": [
7
- {
8
- "type": "node",
9
- "request": "attach",
10
- "name": "Attach",
11
- "address": "localhost",
12
- "port": 9229,
13
- "restart": true,
14
- "sourceMaps": true,
15
- "localRoot": "${workspaceFolder}",
16
- "remoteRoot": "/usr/src/server",
17
- "outFiles": [ "${workspaceFolder}/dist/**/*.js" ],
18
- "protocol":"inspector",
19
- "trace": "sm"
20
- },
21
- {
22
- "type": "node",
23
- "request": "launch",
24
- "name": "Launch Program",
25
- "runtimeArgs": [
26
- "-r",
27
- "ts-node/register"
28
- ],
29
- "args": [
30
- "${workspaceFolder}/src/index.ts"
31
- ]
32
- }
33
- ]
34
- }
2
+ // Use IntelliSense to learn about possible attributes.
3
+ // Hover to view descriptions of existing attributes.
4
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5
+ "version": "0.2.0",
6
+ "configurations": [
7
+ {
8
+ "type": "node",
9
+ "request": "attach",
10
+ "name": "Attach",
11
+ "address": "localhost",
12
+ "port": 9229,
13
+ "restart": true,
14
+ "sourceMaps": true,
15
+ "localRoot": "${workspaceFolder}",
16
+ "remoteRoot": "/usr/src/server",
17
+ "outFiles": ["${workspaceFolder}/dist/**/*.js"],
18
+ "protocol": "inspector",
19
+ "trace": "sm"
20
+ },
21
+ {
22
+ "type": "node",
23
+ "request": "launch",
24
+ "name": "Launch Program",
25
+ "runtimeArgs": ["-r", "ts-node/register"],
26
+ "args": ["${workspaceFolder}/src/index.ts"]
27
+ }
28
+ ]
29
+ }
package/README.md CHANGED
@@ -7,6 +7,7 @@ Azure local service is a minimal, self-contained, test implementation of the Azu
7
7
  The Azure local service includes most of the basic features needed to **test** data stores and containers. While we use the [Webpack Fluid Loader](../../packages/tools/webpack-fluid-loader)'s in browser service for much of our data store and container development, the Azure local service offers some advantages because it's a standalone process. For instance, testing a Fluid container from 2+ simultaneously connected clients is much easier using the Azure local service.
8
8
 
9
9
  ## Getting Started
10
+
10
11
  You can install, build, and start this service by running the following
11
12
 
12
13
  ```sh
@@ -16,10 +17,72 @@ npm run start
16
17
  ```
17
18
 
18
19
  ## Configuration
20
+
19
21
  ### Port
20
- The Azure local service uses port 7070 by default. You can change the port number by setting an environment
21
- variable named PORT to the desired number. For example:
22
+
23
+ The Azure local service uses port 7070 by default. You can change the port number by setting an environment
24
+ variable named PORT to the desired number. For example:
25
+
22
26
  ```sh
23
27
  $env:PORT=6502
24
28
  npm run start
25
29
  ```
30
+
31
+ <!-- AUTO-GENERATED-CONTENT:START (README_CONTRIBUTION_GUIDELINES_SECTION:includeHeading=TRUE) -->
32
+
33
+ <!-- prettier-ignore-start -->
34
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
35
+
36
+ ## Contribution Guidelines
37
+
38
+ There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
39
+
40
+ - Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
41
+ - [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
42
+ - Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
43
+ - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
44
+
45
+ Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
46
+
47
+ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
48
+ For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
49
+
50
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
51
+ Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
52
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
53
+
54
+ <!-- prettier-ignore-end -->
55
+
56
+ <!-- AUTO-GENERATED-CONTENT:END -->
57
+
58
+ <!-- AUTO-GENERATED-CONTENT:START (README_HELP_SECTION:includeHeading=TRUE) -->
59
+
60
+ <!-- prettier-ignore-start -->
61
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
62
+
63
+ ## Help
64
+
65
+ Not finding what you're looking for in this README?
66
+ Check out our [GitHub Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
67
+
68
+ Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
69
+ Thank you!
70
+
71
+ <!-- prettier-ignore-end -->
72
+
73
+ <!-- AUTO-GENERATED-CONTENT:END -->
74
+
75
+ <!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
76
+
77
+ <!-- prettier-ignore-start -->
78
+ <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
79
+
80
+ ## Trademark
81
+
82
+ This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
83
+ Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
84
+ Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
85
+
86
+ <!-- prettier-ignore-end -->
87
+
88
+ <!-- AUTO-GENERATED-CONTENT:END -->
@@ -1,12 +1,12 @@
1
1
  {
2
- "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
- "extends": "@fluidframework/build-common/api-extractor-common-strict.json",
4
- "apiReport": {
5
- "enabled": true,
6
- "reportFolder": "<projectFolder>/api-report/"
7
- },
8
- "docModel": {
9
- "enabled": true,
10
- "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
11
- }
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "@fluidframework/build-common/api-extractor-common-strict.json",
4
+ "apiReport": {
5
+ "enabled": true,
6
+ "reportFolder": "<projectFolder>/api-report/"
7
+ },
8
+ "docModel": {
9
+ "enabled": true,
10
+ "apiJsonFilePath": "<projectFolder>/_api-extractor-temp/doc-models/<unscopedPackageName>.api.json"
11
+ }
12
12
  }
@@ -3,8 +3,5 @@
3
3
  > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
4
 
5
5
  ```ts
6
-
7
-
8
6
  // (No @packageDocumentation comment for this package)
9
-
10
7
  ```
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;GAGG;AAGH,OAAO,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;GAGG;AAEH,OAAO,aAAa,CAAC"}
package/dist/index.js CHANGED
@@ -1,10 +1,10 @@
1
1
  #!/usr/bin/env node
2
2
  "use strict";
3
+ Object.defineProperty(exports, "__esModule", { value: true });
3
4
  /*!
4
5
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
5
6
  * Licensed under the MIT License.
6
7
  */
7
- Object.defineProperty(exports, "__esModule", { value: true });
8
8
  // eslint-disable-next-line import/no-unassigned-import
9
9
  require("tinylicious");
10
10
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AACA;;;GAGG;;AAEH,uDAAuD;AACvD,uBAAqB","sourcesContent":["#!/usr/bin/env node\n/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// eslint-disable-next-line import/no-unassigned-import\nimport \"tinylicious\";\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,uDAAuD;AACvD,uBAAqB","sourcesContent":["#!/usr/bin/env node\n\n/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n// eslint-disable-next-line import/no-unassigned-import\nimport \"tinylicious\";\n"]}
package/package.json CHANGED
@@ -1,54 +1,61 @@
1
1
  {
2
- "name": "@fluidframework/azure-local-service",
3
- "version": "1.2.0-106934",
4
- "description": "Local implementation of the Azure Fluid Relay service for testing/development use",
5
- "homepage": "https://fluidframework.com",
6
- "repository": {
7
- "type": "git",
8
- "url": "https://github.com/microsoft/FluidFramework.git",
9
- "directory": "azure/packages/azure-local-service"
10
- },
11
- "license": "MIT",
12
- "author": "Microsoft and contributors",
13
- "main": "dist/index.js",
14
- "typings": "dist/index.d.ts",
15
- "bin": "dist/index.js",
16
- "scripts": {
17
- "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
18
- "build:compile": "npm run tsc",
19
- "build:docs": "api-extractor run --local",
20
- "build:full": "npm run build",
21
- "build:full:compile": "npm run build:compile",
22
- "ci:build:docs": "api-extractor run",
23
- "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
24
- "eslint": "eslint --format stylish src",
25
- "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
26
- "lint": "npm run eslint",
27
- "lint:fix": "npm run eslint:fix",
28
- "start": "forever start dist/index.js",
29
- "start:debug": "node --inspect=0.0.0.0:9229 dist/index.js",
30
- "stop": "forever stop dist/index.js",
31
- "test": "echo \"Error: no test specified\" && exit 1",
32
- "tsc": "tsc"
33
- },
34
- "dependencies": {
35
- "tinylicious": "^0.4.89251"
36
- },
37
- "devDependencies": {
38
- "@fluidframework/build-common": "^1.1.0",
39
- "@fluidframework/eslint-config-fluid": "^1.1.0",
40
- "@microsoft/api-extractor": "^7.22.2",
41
- "@rushstack/eslint-config": "^2.5.1",
42
- "concurrently": "^6.2.0",
43
- "copyfiles": "^2.4.1",
44
- "eslint": "~8.6.0",
45
- "eslint-plugin-jsdoc": "~39.3.0",
46
- "forever": "^4.0.3",
47
- "rimraf": "^2.6.2",
48
- "ts-node": "^8.6.2",
49
- "typescript": "~4.5.5"
50
- },
51
- "engines": {
52
- "node": ">=14.0.0"
53
- }
2
+ "name": "@fluidframework/azure-local-service",
3
+ "version": "1.2.0",
4
+ "description": "Local implementation of the Azure Fluid Relay service for testing/development use",
5
+ "homepage": "https://fluidframework.com",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/microsoft/FluidFramework.git",
9
+ "directory": "azure/packages/azure-local-service"
10
+ },
11
+ "license": "MIT",
12
+ "author": "Microsoft and contributors",
13
+ "main": "dist/index.js",
14
+ "typings": "dist/index.d.ts",
15
+ "bin": "dist/index.js",
16
+ "scripts": {
17
+ "build": "concurrently npm:build:compile npm:lint && npm run build:docs",
18
+ "build:compile": "npm run tsc",
19
+ "build:docs": "api-extractor run --local",
20
+ "build:full": "npm run build",
21
+ "build:full:compile": "npm run build:compile",
22
+ "ci:build:docs": "api-extractor run",
23
+ "clean": "rimraf dist lib *.tsbuildinfo *.build.log",
24
+ "eslint": "eslint --format stylish src",
25
+ "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
26
+ "format": "npm run prettier:fix",
27
+ "lint": "npm run prettier && npm run eslint",
28
+ "lint:fix": "npm run prettier:fix && npm run eslint:fix",
29
+ "prettier": "prettier --check . --ignore-path ../../../.prettierignore",
30
+ "prettier:fix": "prettier --write . --ignore-path ../../../.prettierignore",
31
+ "start": "forever start dist/index.js",
32
+ "start:debug": "node --inspect=0.0.0.0:9229 dist/index.js",
33
+ "stop": "forever stop dist/index.js",
34
+ "test": "echo \"Error: no test specified\" && exit 1",
35
+ "tsc": "tsc"
36
+ },
37
+ "dependencies": {
38
+ "tinylicious": "0.6.0"
39
+ },
40
+ "devDependencies": {
41
+ "@fluidframework/build-common": "^1.2.0",
42
+ "@fluidframework/eslint-config-fluid": "^2.0.0",
43
+ "@microsoft/api-extractor": "^7.34.4",
44
+ "concurrently": "^7.6.0",
45
+ "copyfiles": "^2.4.1",
46
+ "eslint": "~8.6.0",
47
+ "eslint-plugin-jsdoc": "~39.3.0",
48
+ "forever": "^4.0.3",
49
+ "prettier": "~2.6.2",
50
+ "rimraf": "^2.6.2",
51
+ "ts-node": "^8.6.2",
52
+ "typescript": "~4.5.5"
53
+ },
54
+ "engines": {
55
+ "node": ">=14.0.0"
56
+ },
57
+ "typeValidation": {
58
+ "disabled": true,
59
+ "broken": {}
60
+ }
54
61
  }
package/src/index.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  #!/usr/bin/env node
2
+
2
3
  /*!
3
4
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
4
5
  * Licensed under the MIT License.
5
6
  */
6
-
7
7
  // eslint-disable-next-line import/no-unassigned-import
8
8
  import "tinylicious";
package/tsconfig.json CHANGED
@@ -1,12 +1,10 @@
1
1
  {
2
- "extends": "@fluidframework/build-common/ts-common-config.json",
3
- "exclude": [],
4
- "compilerOptions": {
5
- "rootDir": "./src",
6
- "outDir": "./dist",
7
- "composite": true
8
- },
9
- "include": [
10
- "src/**/*"
11
- ]
2
+ "extends": "@fluidframework/build-common/ts-common-config.json",
3
+ "exclude": [],
4
+ "compilerOptions": {
5
+ "rootDir": "./src",
6
+ "outDir": "./dist",
7
+ "composite": true,
8
+ },
9
+ "include": ["src/**/*"],
12
10
  }