@fluid-experimental/ink 2.0.0-dev-rc.2.0.0.245554
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.cjs +14 -0
- package/.mocharc.cjs +12 -0
- package/CHANGELOG.md +159 -0
- package/LICENSE +21 -0
- package/README.md +71 -0
- package/api-extractor-cjs.json +8 -0
- package/api-extractor-lint.json +4 -0
- package/api-extractor.json +4 -0
- package/api-report/ink.api.md +132 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -0
- package/dist/ink-alpha.d.ts +39 -0
- package/dist/ink-beta.d.ts +41 -0
- package/dist/ink-public.d.ts +41 -0
- package/dist/ink-untrimmed.d.ts +404 -0
- package/dist/ink.d.ts +154 -0
- package/dist/ink.d.ts.map +1 -0
- package/dist/ink.js +247 -0
- package/dist/ink.js.map +1 -0
- package/dist/inkCanvas.d.ts +33 -0
- package/dist/inkCanvas.d.ts.map +1 -0
- package/dist/inkCanvas.js +218 -0
- package/dist/inkCanvas.js.map +1 -0
- package/dist/inkFactory.d.ts +38 -0
- package/dist/inkFactory.d.ts.map +1 -0
- package/dist/inkFactory.js +58 -0
- package/dist/inkFactory.js.map +1 -0
- package/dist/interfaces.d.ts +183 -0
- package/dist/interfaces.d.ts.map +1 -0
- package/dist/interfaces.js +7 -0
- package/dist/interfaces.js.map +1 -0
- package/dist/package.json +3 -0
- package/dist/packageVersion.d.ts +9 -0
- package/dist/packageVersion.d.ts.map +1 -0
- package/dist/packageVersion.js +12 -0
- package/dist/packageVersion.js.map +1 -0
- package/dist/snapshot.d.ts +62 -0
- package/dist/snapshot.d.ts.map +1 -0
- package/dist/snapshot.js +59 -0
- package/dist/snapshot.js.map +1 -0
- package/dist/tsdoc-metadata.json +11 -0
- package/lib/index.d.ts +9 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +8 -0
- package/lib/index.js.map +1 -0
- package/lib/ink-alpha.d.ts +39 -0
- package/lib/ink-beta.d.ts +41 -0
- package/lib/ink-public.d.ts +41 -0
- package/lib/ink-untrimmed.d.ts +404 -0
- package/lib/ink.d.ts +154 -0
- package/lib/ink.d.ts.map +1 -0
- package/lib/ink.js +243 -0
- package/lib/ink.js.map +1 -0
- package/lib/inkCanvas.d.ts +33 -0
- package/lib/inkCanvas.d.ts.map +1 -0
- package/lib/inkCanvas.js +214 -0
- package/lib/inkCanvas.js.map +1 -0
- package/lib/inkFactory.d.ts +38 -0
- package/lib/inkFactory.d.ts.map +1 -0
- package/lib/inkFactory.js +54 -0
- package/lib/inkFactory.js.map +1 -0
- package/lib/interfaces.d.ts +183 -0
- package/lib/interfaces.d.ts.map +1 -0
- package/lib/interfaces.js +6 -0
- package/lib/interfaces.js.map +1 -0
- package/lib/packageVersion.d.ts +9 -0
- package/lib/packageVersion.d.ts.map +1 -0
- package/lib/packageVersion.js +9 -0
- package/lib/packageVersion.js.map +1 -0
- package/lib/snapshot.d.ts +62 -0
- package/lib/snapshot.d.ts.map +1 -0
- package/lib/snapshot.js +55 -0
- package/lib/snapshot.js.map +1 -0
- package/lib/test/ink.spec.js +332 -0
- package/lib/test/ink.spec.js.map +1 -0
- package/package.json +154 -0
- package/prettier.config.cjs +8 -0
- package/src/index.ts +20 -0
- package/src/ink.ts +286 -0
- package/src/inkCanvas.ts +273 -0
- package/src/inkFactory.ts +74 -0
- package/src/interfaces.ts +212 -0
- package/src/packageVersion.ts +9 -0
- package/src/snapshot.ts +88 -0
- package/tsconfig.cjs.json +7 -0
- package/tsconfig.json +9 -0
package/.eslintrc.cjs
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
module.exports = {
|
|
7
|
+
extends: [
|
|
8
|
+
require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
|
|
9
|
+
"prettier",
|
|
10
|
+
],
|
|
11
|
+
parserOptions: {
|
|
12
|
+
project: ["./tsconfig.json", "./src/test/tsconfig.json"],
|
|
13
|
+
},
|
|
14
|
+
};
|
package/.mocharc.cjs
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
"use strict";
|
|
7
|
+
|
|
8
|
+
const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
|
|
9
|
+
|
|
10
|
+
const packageDir = __dirname;
|
|
11
|
+
const config = getFluidTestMochaConfig(packageDir);
|
|
12
|
+
module.exports = config;
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# @fluid-experimental/ink
|
|
2
|
+
|
|
3
|
+
## 2.0.0-rc.2.0.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- @fluidframework/ink package demoted to @fluid-experimental/ink ([#19568](https://github.com/microsoft/FluidFramework/issues/19568)) [0d974d828c](https://github.com/microsoft/FluidFramework/commits/0d974d828cd46061449290caabcaedc7b5f6c1f0)
|
|
8
|
+
|
|
9
|
+
The ink package has always been in an experimental state, but this has not been clearly communicated (primarly just through notes in TODO.md). It has now been moved to the @fluid-experimental scope to more clearly indicate its development state.
|
|
10
|
+
|
|
11
|
+
## 2.0.0-rc.1.0.0
|
|
12
|
+
|
|
13
|
+
### Minor Changes
|
|
14
|
+
|
|
15
|
+
- Updated server dependencies ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
16
|
+
|
|
17
|
+
The following Fluid server dependencies have been updated to the latest version, 3.0.0. [See the full changelog.](https://github.com/microsoft/FluidFramework/releases/tag/server_v3.0.0)
|
|
18
|
+
|
|
19
|
+
- @fluidframework/gitresources
|
|
20
|
+
- @fluidframework/server-kafka-orderer
|
|
21
|
+
- @fluidframework/server-lambdas
|
|
22
|
+
- @fluidframework/server-lambdas-driver
|
|
23
|
+
- @fluidframework/server-local-server
|
|
24
|
+
- @fluidframework/server-memory-orderer
|
|
25
|
+
- @fluidframework/protocol-base
|
|
26
|
+
- @fluidframework/server-routerlicious
|
|
27
|
+
- @fluidframework/server-routerlicious-base
|
|
28
|
+
- @fluidframework/server-services
|
|
29
|
+
- @fluidframework/server-services-client
|
|
30
|
+
- @fluidframework/server-services-core
|
|
31
|
+
- @fluidframework/server-services-ordering-kafkanode
|
|
32
|
+
- @fluidframework/server-services-ordering-rdkafka
|
|
33
|
+
- @fluidframework/server-services-ordering-zookeeper
|
|
34
|
+
- @fluidframework/server-services-shared
|
|
35
|
+
- @fluidframework/server-services-telemetry
|
|
36
|
+
- @fluidframework/server-services-utils
|
|
37
|
+
- @fluidframework/server-test-utils
|
|
38
|
+
- tinylicious
|
|
39
|
+
|
|
40
|
+
- Updated @fluidframework/protocol-definitions ([#19122](https://github.com/microsoft/FluidFramework/issues/19122)) [25366b4229](https://github.com/microsoft/FluidFramework/commits/25366b422918cb43685c5f328b50450749592902)
|
|
41
|
+
|
|
42
|
+
The @fluidframework/protocol-definitions dependency has been upgraded to v3.1.0. [See the full
|
|
43
|
+
changelog.](https://github.com/microsoft/FluidFramework/blob/main/common/lib/protocol-definitions/CHANGELOG.md#310)
|
|
44
|
+
|
|
45
|
+
## 2.0.0-internal.8.0.0
|
|
46
|
+
|
|
47
|
+
Dependency updates only.
|
|
48
|
+
|
|
49
|
+
## 2.0.0-internal.7.4.0
|
|
50
|
+
|
|
51
|
+
Dependency updates only.
|
|
52
|
+
|
|
53
|
+
## 2.0.0-internal.7.3.0
|
|
54
|
+
|
|
55
|
+
Dependency updates only.
|
|
56
|
+
|
|
57
|
+
## 2.0.0-internal.7.2.0
|
|
58
|
+
|
|
59
|
+
Dependency updates only.
|
|
60
|
+
|
|
61
|
+
## 2.0.0-internal.7.1.0
|
|
62
|
+
|
|
63
|
+
Dependency updates only.
|
|
64
|
+
|
|
65
|
+
## 2.0.0-internal.7.0.0
|
|
66
|
+
|
|
67
|
+
### Major Changes
|
|
68
|
+
|
|
69
|
+
- Dependencies on @fluidframework/protocol-definitions package updated to 3.0.0 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
70
|
+
|
|
71
|
+
This included the following changes from the protocol-definitions release:
|
|
72
|
+
|
|
73
|
+
- Updating signal interfaces for some planned improvements. The intention is split the interface between signals
|
|
74
|
+
submitted by clients to the server and the resulting signals sent from the server to clients.
|
|
75
|
+
- A new optional type member is available on the ISignalMessage interface and a new ISentSignalMessage interface has
|
|
76
|
+
been added, which will be the typing for signals sent from the client to the server. Both extend a new
|
|
77
|
+
ISignalMessageBase interface that contains common members.
|
|
78
|
+
- The @fluidframework/common-definitions package dependency has been updated to version 1.0.0.
|
|
79
|
+
|
|
80
|
+
- Server upgrade: dependencies on Fluid server packages updated to 2.0.1 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
81
|
+
|
|
82
|
+
Dependencies on the following Fluid server package have been updated to version 2.0.1:
|
|
83
|
+
|
|
84
|
+
- @fluidframework/gitresources: 2.0.1
|
|
85
|
+
- @fluidframework/server-kafka-orderer: 2.0.1
|
|
86
|
+
- @fluidframework/server-lambdas: 2.0.1
|
|
87
|
+
- @fluidframework/server-lambdas-driver: 2.0.1
|
|
88
|
+
- @fluidframework/server-local-server: 2.0.1
|
|
89
|
+
- @fluidframework/server-memory-orderer: 2.0.1
|
|
90
|
+
- @fluidframework/protocol-base: 2.0.1
|
|
91
|
+
- @fluidframework/server-routerlicious: 2.0.1
|
|
92
|
+
- @fluidframework/server-routerlicious-base: 2.0.1
|
|
93
|
+
- @fluidframework/server-services: 2.0.1
|
|
94
|
+
- @fluidframework/server-services-client: 2.0.1
|
|
95
|
+
- @fluidframework/server-services-core: 2.0.1
|
|
96
|
+
- @fluidframework/server-services-ordering-kafkanode: 2.0.1
|
|
97
|
+
- @fluidframework/server-services-ordering-rdkafka: 2.0.1
|
|
98
|
+
- @fluidframework/server-services-ordering-zookeeper: 2.0.1
|
|
99
|
+
- @fluidframework/server-services-shared: 2.0.1
|
|
100
|
+
- @fluidframework/server-services-telemetry: 2.0.1
|
|
101
|
+
- @fluidframework/server-services-utils: 2.0.1
|
|
102
|
+
- @fluidframework/server-test-utils: 2.0.1
|
|
103
|
+
- tinylicious: 2.0.1
|
|
104
|
+
|
|
105
|
+
- Minimum TypeScript version now 5.1.6 [871b3493dd](https://github.com/microsoft/FluidFramework/commits/871b3493dd0d7ea3a89be64998ceb6cb9021a04e)
|
|
106
|
+
|
|
107
|
+
The minimum supported TypeScript version for Fluid 2.0 clients is now 5.1.6.
|
|
108
|
+
|
|
109
|
+
## 2.0.0-internal.6.4.0
|
|
110
|
+
|
|
111
|
+
Dependency updates only.
|
|
112
|
+
|
|
113
|
+
## 2.0.0-internal.6.3.0
|
|
114
|
+
|
|
115
|
+
Dependency updates only.
|
|
116
|
+
|
|
117
|
+
## 2.0.0-internal.6.2.0
|
|
118
|
+
|
|
119
|
+
Dependency updates only.
|
|
120
|
+
|
|
121
|
+
## 2.0.0-internal.6.1.0
|
|
122
|
+
|
|
123
|
+
Dependency updates only.
|
|
124
|
+
|
|
125
|
+
## 2.0.0-internal.6.0.0
|
|
126
|
+
|
|
127
|
+
### Major Changes
|
|
128
|
+
|
|
129
|
+
- Upgraded typescript transpilation target to ES2020 [8abce8cdb4](https://github.com/microsoft/FluidFramework/commits/8abce8cdb4e2832fb6405fb44e393bef03d5648a)
|
|
130
|
+
|
|
131
|
+
Upgraded typescript transpilation target to ES2020. This is done in order to decrease the bundle sizes of Fluid Framework packages. This has provided size improvements across the board for ex. Loader, Driver, Runtime etc. Reduced bundle sizes helps to load lesser code in apps and hence also helps to improve the perf.If any app wants to target any older versions of browsers with which this target version is not compatible, then they can use packages like babel to transpile to a older target.
|
|
132
|
+
|
|
133
|
+
## 2.0.0-internal.5.4.0
|
|
134
|
+
|
|
135
|
+
Dependency updates only.
|
|
136
|
+
|
|
137
|
+
## 2.0.0-internal.5.3.0
|
|
138
|
+
|
|
139
|
+
Dependency updates only.
|
|
140
|
+
|
|
141
|
+
## 2.0.0-internal.5.2.0
|
|
142
|
+
|
|
143
|
+
Dependency updates only.
|
|
144
|
+
|
|
145
|
+
## 2.0.0-internal.5.1.0
|
|
146
|
+
|
|
147
|
+
Dependency updates only.
|
|
148
|
+
|
|
149
|
+
## 2.0.0-internal.5.0.0
|
|
150
|
+
|
|
151
|
+
Dependency updates only.
|
|
152
|
+
|
|
153
|
+
## 2.0.0-internal.4.4.0
|
|
154
|
+
|
|
155
|
+
Dependency updates only.
|
|
156
|
+
|
|
157
|
+
## 2.0.0-internal.4.1.0
|
|
158
|
+
|
|
159
|
+
Dependency updates only.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
2
|
+
|
|
3
|
+
MIT License
|
|
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,71 @@
|
|
|
1
|
+
# @fluid-experimental/ink
|
|
2
|
+
|
|
3
|
+
Contains a [Distributed Data Structure](https://fluidframework.com/docs/build/dds/) (DDS) for representing digital ink strokes.
|
|
4
|
+
|
|
5
|
+
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_PACKAGE_README:scripts=FALSE&packageScopeNotice=EXPERIMENTAL) -->
|
|
6
|
+
|
|
7
|
+
<!-- prettier-ignore-start -->
|
|
8
|
+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
|
|
9
|
+
|
|
10
|
+
**IMPORTANT: This package is experimental.**
|
|
11
|
+
**Its APIs may change without notice.**
|
|
12
|
+
|
|
13
|
+
**Do not use in production scenarios.**
|
|
14
|
+
|
|
15
|
+
## Using Fluid Framework libraries
|
|
16
|
+
|
|
17
|
+
When taking a dependency on a Fluid Framework library, we recommend using a `^` (caret) version range, such as `^1.3.4`.
|
|
18
|
+
While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
|
|
19
|
+
library consumers should always prefer `^`.
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
To get started, install the package by running the following command:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm i @fluid-experimental/ink
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## API Documentation
|
|
30
|
+
|
|
31
|
+
API documentation for **@fluid-experimental/ink** is available at <https://fluidframework.com/docs/apis/ink>.
|
|
32
|
+
|
|
33
|
+
## Contribution Guidelines
|
|
34
|
+
|
|
35
|
+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
|
|
36
|
+
|
|
37
|
+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
|
|
38
|
+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
|
|
39
|
+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
|
|
40
|
+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
|
|
41
|
+
|
|
42
|
+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
|
|
43
|
+
|
|
44
|
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
45
|
+
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.
|
|
46
|
+
|
|
47
|
+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
48
|
+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
|
|
49
|
+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
50
|
+
|
|
51
|
+
## Help
|
|
52
|
+
|
|
53
|
+
Not finding what you're looking for in this README? Check out our [GitHub
|
|
54
|
+
Wiki](https://github.com/microsoft/FluidFramework/wiki) or [fluidframework.com](https://fluidframework.com/docs/).
|
|
55
|
+
|
|
56
|
+
Still not finding what you're looking for? Please [file an
|
|
57
|
+
issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
|
|
58
|
+
|
|
59
|
+
Thank you!
|
|
60
|
+
|
|
61
|
+
## Trademark
|
|
62
|
+
|
|
63
|
+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
|
|
64
|
+
|
|
65
|
+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
|
66
|
+
|
|
67
|
+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
68
|
+
|
|
69
|
+
<!-- prettier-ignore-end -->
|
|
70
|
+
|
|
71
|
+
<!-- AUTO-GENERATED-CONTENT:END -->
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
|
|
4
|
+
// CJS is actually secondary; so, no report.
|
|
5
|
+
"apiReport": {
|
|
6
|
+
"enabled": false
|
|
7
|
+
}
|
|
8
|
+
}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
## API Report File for "@fluid-experimental/ink"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
8
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
9
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
10
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
11
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
12
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
13
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
14
|
+
import { ISharedObject } from '@fluidframework/shared-object-base';
|
|
15
|
+
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
|
|
16
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
17
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
18
|
+
|
|
19
|
+
// @internal
|
|
20
|
+
export interface IClearOperation {
|
|
21
|
+
time: number;
|
|
22
|
+
type: "clear";
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// @internal
|
|
26
|
+
export interface IColor {
|
|
27
|
+
a: number;
|
|
28
|
+
b: number;
|
|
29
|
+
g: number;
|
|
30
|
+
r: number;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
// @internal
|
|
34
|
+
export interface ICreateStrokeOperation {
|
|
35
|
+
id: string;
|
|
36
|
+
pen: IPen;
|
|
37
|
+
time: number;
|
|
38
|
+
type: "createStroke";
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// @internal
|
|
42
|
+
export interface IInk extends ISharedObject<IInkEvents> {
|
|
43
|
+
appendPointToStroke(point: IInkPoint, id: string): IInkStroke;
|
|
44
|
+
clear(): void;
|
|
45
|
+
createStroke(pen: IPen): IInkStroke;
|
|
46
|
+
getStroke(key: string): IInkStroke;
|
|
47
|
+
getStrokes(): IInkStroke[];
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// @internal (undocumented)
|
|
51
|
+
export interface IInkEvents extends ISharedObjectEvents {
|
|
52
|
+
// (undocumented)
|
|
53
|
+
(event: "stylus", listener: (operation: IStylusOperation) => void): any;
|
|
54
|
+
// (undocumented)
|
|
55
|
+
(event: "clear", listener: () => void): any;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
// @internal
|
|
59
|
+
export type IInkOperation = IClearOperation | ICreateStrokeOperation | IStylusOperation;
|
|
60
|
+
|
|
61
|
+
// @internal
|
|
62
|
+
export interface IInkPoint {
|
|
63
|
+
pressure: number;
|
|
64
|
+
time: number;
|
|
65
|
+
x: number;
|
|
66
|
+
y: number;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// @internal
|
|
70
|
+
export interface IInkStroke {
|
|
71
|
+
id: string;
|
|
72
|
+
pen: IPen;
|
|
73
|
+
points: IInkPoint[];
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// @internal @sealed
|
|
77
|
+
export class Ink extends SharedObject<IInkEvents> implements IInk {
|
|
78
|
+
constructor(runtime: IFluidDataStoreRuntime, id: string, attributes: IChannelAttributes);
|
|
79
|
+
appendPointToStroke(point: IInkPoint, id: string): IInkStroke;
|
|
80
|
+
// (undocumented)
|
|
81
|
+
protected applyStashedOp(): void;
|
|
82
|
+
clear(): void;
|
|
83
|
+
static create(runtime: IFluidDataStoreRuntime, id?: string): Ink;
|
|
84
|
+
createStroke(pen: IPen): IInkStroke;
|
|
85
|
+
static getFactory(): InkFactory;
|
|
86
|
+
getStroke(key: string): IInkStroke;
|
|
87
|
+
getStrokes(): IInkStroke[];
|
|
88
|
+
protected loadCore(storage: IChannelStorageService): Promise<void>;
|
|
89
|
+
protected onDisconnect(): void;
|
|
90
|
+
protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
|
|
91
|
+
protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// @internal (undocumented)
|
|
95
|
+
export class InkCanvas {
|
|
96
|
+
constructor(canvas: HTMLCanvasElement, model: IInk);
|
|
97
|
+
// (undocumented)
|
|
98
|
+
clear(): void;
|
|
99
|
+
// (undocumented)
|
|
100
|
+
replay(): void;
|
|
101
|
+
// (undocumented)
|
|
102
|
+
setPenColor(color: IColor): void;
|
|
103
|
+
// (undocumented)
|
|
104
|
+
sizeCanvasBackingStore(): void;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// @internal @sealed
|
|
108
|
+
export class InkFactory implements IChannelFactory {
|
|
109
|
+
static readonly Attributes: IChannelAttributes;
|
|
110
|
+
get attributes(): IChannelAttributes;
|
|
111
|
+
create(runtime: IFluidDataStoreRuntime, id: string): ISharedObject;
|
|
112
|
+
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;
|
|
113
|
+
static Type: string;
|
|
114
|
+
get type(): string;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
// @internal
|
|
118
|
+
export interface IPen {
|
|
119
|
+
color: IColor;
|
|
120
|
+
thickness: number;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
// @internal
|
|
124
|
+
export interface IStylusOperation {
|
|
125
|
+
id: string;
|
|
126
|
+
point: IInkPoint;
|
|
127
|
+
type: "stylus";
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// (No @packageDocumentation comment for this package)
|
|
131
|
+
|
|
132
|
+
```
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License.
|
|
4
|
+
*/
|
|
5
|
+
export { Ink } from "./ink.js";
|
|
6
|
+
export { InkCanvas } from "./inkCanvas.js";
|
|
7
|
+
export { InkFactory } from "./inkFactory.js";
|
|
8
|
+
export { IClearOperation, IColor, ICreateStrokeOperation, IInk, IInkEvents, IInkOperation, IInkPoint, IInkStroke, IPen, IStylusOperation, } from "./interfaces.js";
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EACN,eAAe,EACf,MAAM,EACN,sBAAsB,EACtB,IAAI,EACJ,UAAU,EACV,aAAa,EACb,SAAS,EACT,UAAU,EACV,IAAI,EACJ,gBAAgB,GAChB,MAAM,iBAAiB,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*!
|
|
3
|
+
* Copyright (c) Microsoft Corporation and contributors. All rights reserved.
|
|
4
|
+
* Licensed under the MIT License.
|
|
5
|
+
*/
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.InkFactory = exports.InkCanvas = exports.Ink = void 0;
|
|
8
|
+
var ink_js_1 = require("./ink.js");
|
|
9
|
+
Object.defineProperty(exports, "Ink", { enumerable: true, get: function () { return ink_js_1.Ink; } });
|
|
10
|
+
var inkCanvas_js_1 = require("./inkCanvas.js");
|
|
11
|
+
Object.defineProperty(exports, "InkCanvas", { enumerable: true, get: function () { return inkCanvas_js_1.InkCanvas; } });
|
|
12
|
+
var inkFactory_js_1 = require("./inkFactory.js");
|
|
13
|
+
Object.defineProperty(exports, "InkFactory", { enumerable: true, get: function () { return inkFactory_js_1.InkFactory; } });
|
|
14
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mCAA+B;AAAtB,6FAAA,GAAG,OAAA;AACZ,+CAA2C;AAAlC,yGAAA,SAAS,OAAA;AAClB,iDAA6C;AAApC,2GAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { Ink } from \"./ink.js\";\nexport { InkCanvas } from \"./inkCanvas.js\";\nexport { InkFactory } from \"./inkFactory.js\";\nexport {\n\tIClearOperation,\n\tIColor,\n\tICreateStrokeOperation,\n\tIInk,\n\tIInkEvents,\n\tIInkOperation,\n\tIInkPoint,\n\tIInkStroke,\n\tIPen,\n\tIStylusOperation,\n} from \"./interfaces.js\";\n"]}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
2
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
3
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
7
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
8
|
+
import { ISharedObject } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: IClearOperation */
|
|
14
|
+
|
|
15
|
+
/* Excluded from this release type: IColor */
|
|
16
|
+
|
|
17
|
+
/* Excluded from this release type: ICreateStrokeOperation */
|
|
18
|
+
|
|
19
|
+
/* Excluded from this release type: IInk */
|
|
20
|
+
|
|
21
|
+
/* Excluded from this release type: IInkEvents */
|
|
22
|
+
|
|
23
|
+
/* Excluded from this release type: IInkOperation */
|
|
24
|
+
|
|
25
|
+
/* Excluded from this release type: IInkPoint */
|
|
26
|
+
|
|
27
|
+
/* Excluded from this release type: IInkStroke */
|
|
28
|
+
|
|
29
|
+
/* Excluded from this release type: Ink */
|
|
30
|
+
|
|
31
|
+
/* Excluded from this release type: InkCanvas */
|
|
32
|
+
|
|
33
|
+
/* Excluded from this release type: InkFactory */
|
|
34
|
+
|
|
35
|
+
/* Excluded from this release type: IPen */
|
|
36
|
+
|
|
37
|
+
/* Excluded from this release type: IStylusOperation */
|
|
38
|
+
|
|
39
|
+
export { }
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
2
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
3
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
7
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
8
|
+
import { ISharedObject } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: IClearOperation */
|
|
14
|
+
|
|
15
|
+
/* Excluded from this release type: IColor */
|
|
16
|
+
|
|
17
|
+
/* Excluded from this release type: ICreateStrokeOperation */
|
|
18
|
+
|
|
19
|
+
/* Excluded from this release type: IInk */
|
|
20
|
+
|
|
21
|
+
/* Excluded from this release type: IInkEvents */
|
|
22
|
+
|
|
23
|
+
/* Excluded from this release type: IInkOperation */
|
|
24
|
+
|
|
25
|
+
/* Excluded from this release type: IInkPoint */
|
|
26
|
+
|
|
27
|
+
/* Excluded from this release type: IInkStroke */
|
|
28
|
+
|
|
29
|
+
/* Excluded from this release type: Ink */
|
|
30
|
+
|
|
31
|
+
/* Excluded from this release type: InkCanvas */
|
|
32
|
+
|
|
33
|
+
/* Excluded from this release type: InkFactory */
|
|
34
|
+
|
|
35
|
+
/* Excluded from this release type: IPen */
|
|
36
|
+
|
|
37
|
+
/* Excluded from this release type: IStylusOperation */
|
|
38
|
+
|
|
39
|
+
/* Excluded from this release type: SharedObject */
|
|
40
|
+
|
|
41
|
+
export { }
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { IChannelAttributes } from '@fluidframework/datastore-definitions';
|
|
2
|
+
import { IChannelFactory } from '@fluidframework/datastore-definitions';
|
|
3
|
+
import { IChannelServices } from '@fluidframework/datastore-definitions';
|
|
4
|
+
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
|
|
5
|
+
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
|
|
6
|
+
import { IFluidSerializer } from '@fluidframework/shared-object-base';
|
|
7
|
+
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
|
|
8
|
+
import { ISharedObject } from '@fluidframework/shared-object-base';
|
|
9
|
+
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
|
|
10
|
+
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
|
|
11
|
+
import { SharedObject } from '@fluidframework/shared-object-base';
|
|
12
|
+
|
|
13
|
+
/* Excluded from this release type: IClearOperation */
|
|
14
|
+
|
|
15
|
+
/* Excluded from this release type: IColor */
|
|
16
|
+
|
|
17
|
+
/* Excluded from this release type: ICreateStrokeOperation */
|
|
18
|
+
|
|
19
|
+
/* Excluded from this release type: IInk */
|
|
20
|
+
|
|
21
|
+
/* Excluded from this release type: IInkEvents */
|
|
22
|
+
|
|
23
|
+
/* Excluded from this release type: IInkOperation */
|
|
24
|
+
|
|
25
|
+
/* Excluded from this release type: IInkPoint */
|
|
26
|
+
|
|
27
|
+
/* Excluded from this release type: IInkStroke */
|
|
28
|
+
|
|
29
|
+
/* Excluded from this release type: Ink */
|
|
30
|
+
|
|
31
|
+
/* Excluded from this release type: InkCanvas */
|
|
32
|
+
|
|
33
|
+
/* Excluded from this release type: InkFactory */
|
|
34
|
+
|
|
35
|
+
/* Excluded from this release type: IPen */
|
|
36
|
+
|
|
37
|
+
/* Excluded from this release type: IStylusOperation */
|
|
38
|
+
|
|
39
|
+
/* Excluded from this release type: SharedObject */
|
|
40
|
+
|
|
41
|
+
export { }
|