initial commit.

add typical configuration files (deno, vscode, typescript) used in all of my repos.

.gitignore

@@ -1,130 +1,22 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+# distribution builds and documentation builds
+/dist/
+/docs/
+/node_modules/
+/npm/
+/temp/
+/package.json
+/tsconfig.json
+
+# version lock files
+/deno.lock
+/deno.d.ts
+
+# automatic file clones
+/src/readme.md
+/src/license.md
+
+# build scripts (TODO: temporary, until `@oazmi/build-tools` is not finallized)
+/build_dist.ts
+/build_tools.ts
+/clean.ts
+/.github/

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+	"recommendations": [
+		"denoland.vscode-deno"
+	]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+	"editor.insertSpaces": false,
+	"editor.detectIndentation": false,
+	"editor.inlineSuggest.suppressSuggestions": true,
+	"files.insertFinalNewline": true,
+	"files.eol": "\r\n",
+	"telemetry.telemetryLevel": "off",
+	"html.format.wrapLineLength": 360,
+	"javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": true,
+	"javascript.format.semicolons": "remove",
+	"javascript.preferences.quoteStyle": "double",
+	"typescript.format.semicolons": "remove",
+	"typescript.preferences.quoteStyle": "double",
+	"typescript.inlayHints.parameterNames.enabled": "none",
+	"typescript.inlayHints.enumMemberValues.enabled": false,
+	"typescript.inlayHints.functionLikeReturnTypes.enabled": false,
+	"typescript.inlayHints.parameterTypes.enabled": false,
+	"typescript.inlayHints.propertyDeclarationTypes.enabled": false,
+	"typescript.inlayHints.variableTypes.enabled": false,
+	"typescript.inlayHints.variableTypes.suppressWhenTypeMatchesName": false,
+	"deno.unstable": true,
+	"deno.enable": true,
+	"deno.disablePaths": [
+		"**/package.json"
+	]
+}

deno.json

@@ -0,0 +1,80 @@
+{
+	"name": "@oazmi/socks",
+	"version": "0.1.0",
+	"description": "utility library for websockets between a server and client.",
+	"author": "Omar Azmi",
+	"license": "Anti-Competition License",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/oazmi/socks.git"
+	},
+	"bugs": {
+		"url": "https://github.com/oazmi/socks/issues"
+	},
+	"exports": {
+		".": "./src/mod.ts",
+		"./funcdefs": "./src/funcdefs.ts",
+		"./typedefs": "./src/typedefs.ts"
+	},
+	"publish": {
+		"exclude": [
+			"./.vscode/",
+			"./.github/",
+			"./examples/",
+			"./test/"
+		]
+	},
+	"test": {
+		"include": [
+			"./test/",
+			"./src/mod.ts"
+		]
+	},
+	"fmt": {
+		"useTabs": true,
+		"semiColons": false,
+		"singleQuote": false,
+		"lineWidth": 800,
+		"proseWrap": "never",
+		"include": [
+			"./src/"
+		]
+	},
+	"compilerOptions": {
+		"lib": [
+			"esnext",
+			"dom",
+			"deno.ns"
+		],
+		"strict": true,
+		"allowJs": true
+	},
+	"package_json": {
+		"dependencies": {},
+		"devDependencies": {
+			"typescript": "^5.0.0",
+			"esbuild": "^0.20.1",
+			"typedoc": "^0.25.9",
+			"typedoc-plugin-missing-exports": "^2.2.0"
+		},
+		"keywords": [
+			"websocket",
+			"wrapper",
+			"wrapper-library",
+			"time-sync",
+			"time-synchronization",
+			"speedtest",
+			"speed-test"
+		]
+	},
+	"node_packageManager": "npm",
+	"tasks": {
+		"build-dist": "deno run -A ./build_dist.ts",
+		"build-docs": "deno run -A ./build_docs.ts",
+		"build-npm": "deno run -A ./build_npm.ts",
+		"build-npm-dist": "cd \"./npm/\" && npm run build-dist",
+		"clean": "deno run -A ./clean.ts",
+		"test": "deno test -A",
+		"publish-jsr": "deno publish --allow-slow-types"
+	}
+}

license.md

@@ -0,0 +1,32 @@
+# Anti-Competition License
+
+Copyright (c) [2024] [Omar Azmi]
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+4. The software may be used in open source and closed source projects.
+If used in a closed source project, the project must provide attribution to this software.
+
+5. Redistributions of this software in any form must not be used in the development, training, or operation of an Artificial Intelligence system.
+
+6. The software or its derivatives must not be used in any form of crawling or caching that is not directly related to code archiving.
+
+7. No portion of this software may be copied or used in another codebase without proper attribution to the original work.
+
+8. Derivative works that directly compete with the original software are not permitted.
+Major enhancements or modifications should ideally be contributed back to the original software's development.
+This is to prevent the intent of diverting existing or potential users away from the original work.
+
+9. Redistribution for the sole purpose of competing with the original software is not permitted.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

readme.md

@@ -0,0 +1,16 @@
+# Socks
+A TypeScript wrapper library that simplifies websocket establishment and communication between a server and client.
+
+## Non-mandatory examples:
+
+Clock time synchronization between server and client (somewhat similar to _Network Time Protocol_ (NTP))
+
+```tsx
+// TODO: implementation
+```
+
+Speed test, including uplink, downlink, and ping between the server and client.
+
+```tsx
+// TODO: implementation
+```