Merge pull request #148 from ctrlaltdavid/housekeeping

Housekeeping

PUBLISH.md

@@ -0,0 +1,22 @@
+
+# Publishing to NPM
+
+Build for release:
+```
+npm run clean
+npm run build-prod
+```
+
+Package for release:
+```
+npm pack
+```
+
+This creates the SDK package, `vircadia-web-sdk-vvvv.v.v.tgz`.
+
+Publish the package to https://npmjs.com:
+
+```
+npm login
+npm publish --access public
+```

README.md

@@ -13,9 +13,9 @@ The SDK is written in TypeScript.
 - [Project Configuration](CONFIGURATION.md)
 - [Coding Standard](CODING_STANDARD.md)
 
-To learn more about using Vircadia's metaverse ecosystem, see the [Developer Documentation](https://docs.vircadia.dev).
+The SDK is published at NPM: https://www.npmjs.com/package/@vircadia/web-sdk
 
-For scripting API documentation, see the [Vircadia API Reference](https://apidocs.vircadia.dev).
+To learn more about using Vircadia's metaverse ecosystem, see the [Developer Documentation](https://docs.vircadia.dev).
 
 
 ## Prerequisites
@@ -32,7 +32,7 @@ https://nodejs.org/en/download/
 [Jest](https://jestjs.io/) is used for unit testing. It is included as an NPM dev dependency, however, you may also install it globally if you want
 to. 
 
-## Project setup
+## Project Setup
 
 ### Get the source
 
@@ -57,7 +57,7 @@ npm install
 ```
 Loads all the supporting NPM packages as defined in `package.json` into the `node_modules` directory.
 
-## Development and testing
+## Development and Testing
 
 ### Compile and minify for development
 ```
@@ -142,26 +142,3 @@ Developer documentation (includes SDK API documentation):
 ```
 npm run devdoc
 ```
-
-
-### Publish to NPM
-
-Build for release:
-```
-npm run clean
-npm run build-prod
-```
-
-Package for release:
-```
-npm pack
-```
-
-This creates the SDK package, `vircadia-web-sdk-vvvv.v.v.tgz`.
-
-Publish the package to https://npmjs.com:
-
-```
-npm login
-npm publish --access public
-```

mocks/domain/audio/AudioWorklets.mock.js

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 13 Dec 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

mocks/worker-url.mock.js

@@ -8,6 +8,7 @@
 //
 //  Created by David Rowe on 13 Dec 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/AudioMixer.ts

@@ -5,6 +5,7 @@
 //
 //  Created by David Rowe on 24 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/Camera.ts

@@ -5,6 +5,7 @@
 //
 //  Created by David Rowe on 5 May 2022.
 //  Copyright 2022 Vircadia contributors.
+//  Copyright 2022 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/MessageMixer.ts

@@ -5,6 +5,7 @@
 //
 //  Created by David Rowe on 23 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/Vircadia.ts

@@ -5,6 +5,7 @@
 //
 //  Created by David Rowe on 9 May 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/AssignmentClient.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 19 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/AvatarManager.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 29 Oct 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio-client/AudioClient.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 15 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio/AudioConstants.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 11 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio/AudioInput.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 24 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio/AudioOutput.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 19 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio/AudioWorklets.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 13 Dec 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/audio/InboundAudioStream.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 16 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/avatars/AvatarDataPacket.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 5 Nov 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/FingerprintUtils.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 14 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/HMACAuth.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 27 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/LimitedNodeList.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 7 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/MessageData.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 11 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/MessagesClient.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 2 Oct 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/NetworkPeer.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 11 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/Node.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 11 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/NodePermissions.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 11 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/NodeType.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 18 May 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/PacketReceiver.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 8 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/PingType.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 6 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/SockAddr.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 7 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/SocketType.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 1 Sep 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/AvatarIdentity.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 29 Oct 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/AvatarQuery.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 10 May 2022.
 //  Copyright 2022 Vircadia contributors.
+//  Copyright 2022 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainConnectRequest.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 7 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainConnectionDenied.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 2 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainDisconnectRequest.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 26 Jul 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainList.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 9 Jun 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainListRequest.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 28 Jul 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/DomainServerRemovedNode.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 20 Aug 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/EntityQuery.ts

@@ -3,6 +3,7 @@
 //
 //  Created by Julien Merzoug on 27 Apr 2022.
 //  Copyright 2022 Vircadia contributors.
+//  Copyright 2022 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/KillAvatar.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 3 Nov 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/MessagesData.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 4 Oct 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

src/domain/networking/packets/MessagesSubscribe.ts

@@ -3,6 +3,7 @@
 //
 //  Created by David Rowe on 4 Oct 2021.
 //  Copyright 2021 Vircadia contributors.
+//  Copyright 2021 DigiSomni LLC.
 //
 //  Distributed under the Apache License, Version 2.0.
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html